To force us to document our code.

I didn’t added it to binaries (src/ and plume-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?

trinity-1686a reviewed 1 year ago

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 clippy or check?

Isn’t there a better way to allow just these warnings in clippy?

Codecov Report

Merging #727 into master will decrease coverage by 0.02%.
The diff coverage is n/a.

@@            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

This pull request has changes conflicting with the target branch.

Cargo.toml

plume-cli/Cargo.toml

plume-models/Cargo.toml

No reviewers

A: Meta

C: Enhancement

S: Ready for review

Suggestion

No Milestone

No Assignees

2 Participants

Notifications

Due Date

No due date set.

Dependencies

This pull request currently doesn't have any dependencies.

#727 Add warning for missing documentation

Codecov Report