Add warning for missing documentation #727
Open
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
elegaanz
added
C: Enhancement
There was a problem hiding this comment.
The overall idea sounds reasonable. Considering src/ (maybe plume-cli) also contains some non trivial code (remember url! in the custom domain PR?), I think doing it would make sense to apply that on them too
You should add a feature to all crates, and replace current attribute with #![cfg_attr(not(feature = "ci"), warn(missing_docs))] (which would be set in CI). That way it won't fail on the deny(warnings) on clippy
|
can't we add that that somewhere to |
|
Isn't there a better way to allow just these warnings in clippy? |
Codecov Report
@@ Coverage Diff @@
## master #727 +/- ##
==========================================
- Coverage 39.17% 39.15% -0.03%
==========================================
Files 73 73
Lines 9653 9653
Branches 2183 2182 -1
==========================================
- Hits 3782 3780 -2
Misses 4819 4819
- Partials 1052 1054 +2 |
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.
To force us to document our code.
I didn't added it to binaries (
src/andplume-cli/because it didn't really made sense for them IMO), but I can.Also, to keep this PR small, I propose that we slowly document each function as we modify them in other PRs. Does it seem reasonable to you?