-
Notifications
You must be signed in to change notification settings - Fork 56
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomers
Description
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
?
, nottry!
, notunwrap
(C-QUESTION-MARK)- The uses of .unwrap() are justified.
- 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.
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomers