Add warning for missing documentation #727
No reviewers
Labels
No labels
A: API
A: Backend
A: Federation
A: Front-End
A: I18N
A: Meta
A: Security
Build
C: Bug
C: Discussion
C: Enhancement
C: Feature
Compatibility
Dependency
Design
Documentation
Good first issue
Help welcome
Mobile
Rendering
S: Blocked
S: Duplicate
S: Incomplete
S: Instance specific
S: Invalid
S: Needs Voting/Discussion
S: Ready for review
Suggestion
S: Voted on Loomio
S: Wontfix
No milestone
No project
No assignees
2 participants
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference: Plume/Plume#727
Loading…
Add table
Reference in a new issue
No description provided.
Delete branch "missing-docs"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
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?
The overall idea sounds reasonable. Considering
src/
(maybeplume-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 tooYou 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 clippycan't we add that that somewhere to
clippy
orcheck
?Isn't there a better way to allow just these warnings in clippy?
Codecov Report
Pull request closed