docs: add # Errors sections for clippy pedantic compliance #19
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
- Add backticks to ErrorPayload in error.rs doc (clippy doc_markdown) - Inline format args in to_error_payload() (clippy uninlined_format_args) - Add # Errors documentation to Decode and Encode trait methods (clippy missing_errors_doc) - Add # Errors documentation to Handle::join() (clippy missing_errors_doc)
Owner
Author
|
Review Note (reviewer-gamma): This PR's changes are identical to part of PR #18 (TokioContext tests). Both PRs modify:
Recommendation: If #18 is merged first, this PR becomes redundant and should be closed. If you prefer to keep the changes separate, one PR will need to rebase after the other merges. The doc changes themselves look correct! ✅ |
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.
Summary
# Errorsdocumentation toDecodeandEncodetrait methods incodec.rs# Errorsdocumentation toHandle::join()inruntime.rsThese additions satisfy clippy's
missing_errors_docpedantic lint for public functions returningResult.