Avoid undocumented panics and enable clippy::missing-panics-doc
#140
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
|
(Though I still feel that perhaps |
edmorley
changed the title
clippy::missing-panics-doc
Malax
approved these changes
Nov 11, 2021
edmorley
force-pushed
the
edmorley/missing-panics-docwarning
branch
from
62b707c to
5ce9928
Compare
Switches the `panic!` in `LayerEnv::read_from_layer_dir()` to `unreachable!`, since: - it more clearly indicates the intent (unreachable code unless there is a bug) - it means we can globally enable the `clippy::missing-panics-doc` lint, without having to either: (a) add an unnecessary `# Panic` section to the docs (which would only add noise, given the caller needn't be aware of panics for internal bugs) (b) add an `#[allow(...)]` annotation to all of `read_from_layer_dir`, which could mean future new undocumented panics aren't caught by clippy. Fixes #54.
edmorley
force-pushed
the
edmorley/missing-panics-docwarning
branch
from
5ce9928 to
9098757
Compare
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.
Switches the
panic!inLayerEnv::read_from_layer_dir()tounreachable!, since:clippy::missing-panics-doclint, without having to either:(a) add an unnecessary
# Panicsection to the docs (which would only add noise, given the caller needn't be aware of panics for internal bugs)(b) add an
#[allow(...)]annotation to all ofread_from_layer_dir(), which could mean future new undocumented panics aren't caught by clippy.Fixes #54.
GUS-W-10167912.