Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Module-level documentation #14

Open
liquidev opened this issue Jan 5, 2022 · 0 comments
Open

Module-level documentation #14

liquidev opened this issue Jan 5, 2022 · 0 comments
Labels
language feature Adding a new feature into the language.

Comments

@liquidev
Copy link
Member

liquidev commented Jan 5, 2022

There needs to be a way of documenting modules. Right now documentation comments document whatever follows, but module-level documentation is a different case, as modules are defined by the file structure rather than syntax.

Therefore, I propose the following syntax for module-level docs:

#! This is a module-level documentation comment.
#! Hello, world!
@liquidev liquidev added the language feature Adding a new feature into the language. label Jan 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
language feature Adding a new feature into the language.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@liquidev