Add more docs for libcnb-test #441
Merged
Conversation
This file contains hidden or 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
All public structs and methods are now documented and missing examples have been added. Some last remaining `.unwrap()` usages have been switched to `.expect()`, since it (a) gives better error messages, (b) means the `clippy::missing_panics_doc` lint no longer insists on the `# Panics` rustdocs section (which is redundant for `libcnb-test`, since we state upfront that failures mean panics, given that's how tests indicate failures). Closes #406.
edmorley
commented
Jun 30, 2022
edmorley
commented
Jun 30, 2022
Malax
reviewed
Jun 30, 2022
Malax
approved these changes
Jun 30, 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.
All public structs and methods are now documented and missing examples have been added. Some existing examples with mis-formatted code have also been fixed.
Some last remaining
.unwrap()usages have been switched to.expect(), since it (a) gives better error messages, (b) means theclippy::missing_panics_doclint no longer insists on the# Panicsrustdocs section (which is redundant forlibcnb-test, since we state upfront that failures mean panics, given that's how tests indicate failures).Closes #406.
GUS-W-11375182.