Add lint for pub fns returning a Result without documenting errors
#4884
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
RobbieClarken
force-pushed
the
warn-missing-errors
branch
from
1d5f7aa
to
3b71ee4
Compare
The Rust Book recommends that functions that return a `Result` type have a doc comment with an `# Errors` section describing the kind of errors that can be returned (https://doc.rust-lang.org/book/ch14-02-publishing-to-crates-io.html#commonly-used-sections). This change adds a lint to enforce this. The lint is allow by default; it can be enabled with `#![warn(clippy::missing_errors_doc)]`. Closes rust-lang#4854.
RobbieClarken
force-pushed
the
warn-missing-errors
branch
from
3b71ee4
to
f5d0a45
Compare
|
Looks good to me. Thanks! @bors r+ |
|
📌 Commit f5d0a45 has been approved by |
bors
added a commit
that referenced
this pull request
Dec 6, 2019
Add lint for pub fns returning a `Result` without documenting errors The Rust Book recommends that functions that return a `Result` type have [a doc comment with an `# Errors` section](https://doc.rust-lang.org/book/ch14-02-publishing-to-crates-io.html#commonly-used-sections) describing the kind of errors that can be returned. This change adds a lint to enforce this. The lint is allow by default; it can be enabled with `#![warn(clippy::missing_errors_doc)]`. Closes #4854. changelog: adds lint for `missing_errors_doc`
|
☀️ Test successful - checks-travis, status-appveyor |
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.
The Rust Book recommends that functions that return a
Resulttype have a doc comment with an# Errorssection describing the kind of errors that can be returned. This change adds a lint to enforce this. The lint is allow by default; it can be enabled with#![warn(clippy::missing_errors_doc)].Closes #4854.
changelog: adds lint for
missing_errors_doc