Better follow API guidelines #102
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Follow guideline: Getter names follow Rust convention (C-GETTER)
Follow guideline: Methods on collections that produce iterators follow iter, iter_mut, into_iter (C-ITER)
Follow: Types eagerly implement common traits (C-COMMON-TRAITS)
madsmtm
added
documentation
madsmtm
force-pushed
the
follow-api-guidelines
branch
from
b0eddb4 to
f4ffd99
Compare
|
For the crate level docs vs. README, there's not really a concise guideline to follow, so I've chosen to deduplicate it, and put most of it in the crate-level docs. |
Follow: Input syntax is evocative of the output (C-EVOCATIVE)
Follow: Type fragments are flexible (C-MACRO-TY)
Part of following: Crate level docs are thorough and include examples (C-CRATE-DOC)
Oversight from #99
Follow: Crate level docs are thorough and include examples (C-CRATE-DOC)
Here's to hoping it actually works, I don't have a new enough system to actually test it
madsmtm
force-pushed
the
follow-api-guidelines
branch
from
6fda875 to
2bb9180
Compare
This was referenced Jan 6, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Part of #25.
Contains a whole mixed bag of changes, see the changelogs and the diff.