docs: Add missing errors and panic docs#296
Open
TheJanzap wants to merge 4 commits intomainmatter:mainfrom
Open
docs: Add missing errors and panic docs#296TheJanzap wants to merge 4 commits intomainmatter:mainfrom
TheJanzap wants to merge 4 commits intomainmatter:mainfrom
Conversation
TheJanzap
force-pushed
the
missing-errors-doc
branch
from
23e8286 to
febe6b5
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
I've added Error and Panics chapter in the doc comments of functions that error/panic. As far as I can tell, these are correct, but I'd like you to verify them.
These fixes the
clippy::missing_panic_docsandclippy::missing_error_docslints I've avoided in #291 and #294.