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

Improve documentation #149

Open
4 tasks
madsmtm opened this issue Aug 31, 2023 · 0 comments
Open
4 tasks

Improve documentation #149

madsmtm opened this issue Aug 31, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@madsmtm
Copy link
Member

madsmtm commented Aug 31, 2023

From the Rust API guidelines:

  • Crate level docs are thorough and include examples (C-CRATE-DOC)
  • All items have a rustdoc example (C-EXAMPLE)
  • Examples use ?, not try!, not unwrap (C-QUESTION-MARK)
  • Function docs include error, panic, and safety considerations (C-FAILURE)

I think there are some clippy/cargo-check features to turn on that can help with ensuring this.
@madsmtm madsmtm added documentation Improvements or additions to documentation good first issue Good for newcomers labels Aug 31, 2023
@madsmtm madsmtm mentioned this issue Aug 31, 2023
Closed
54 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Milestone
No milestone
Development

No branches or pull requests
1 participant
@madsmtm