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.

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

Standard library documentation #132

Open
liquidev opened this issue Jan 29, 2023 · 0 comments
Open

Standard library documentation #132

liquidev opened this issue Jan 29, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request language feature

Comments

@liquidev
Copy link
Member

Mica needs some canonical way of documenting the standard library (and other modules.) To facilitate this, a documentation comment construct should be added into the language.

#! This is module-level documentation.

# This is a normal comment

## This is a documentation comment documenting an item
struct Example impl
    ## This is another doc comment, but documenting a function.
    func example() = nil
end

The Rust API should expose methods that allow for extracting these doc comments from the source code, such that tooling for building autogenerated docs can be built.

@liquidev liquidev added documentation Improvements or additions to documentation enhancement New feature or request language feature labels Jan 29, 2023
@github-project-automation github-project-automation bot moved this to 📦 Backlog in Mica 1.0 Jan 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request language feature
Projects
Status: 📦 Backlog
Development

No branches or pull requests

1 participant