#727 Add warning for missing documentation

Open
elegaanz wants to merge 3 commits from missing-docs into master
elegaanz commented 10 months ago (Migrated from github.com)

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?

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 10 months ago
trinity-1686a left a 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

igalic commented 10 months ago (Migrated from github.com)
Owner

can’t we add that that somewhere to clippy or check?

can't we add that that somewhere to `clippy` or `check`?
elegaanz commented 10 months ago (Migrated from github.com)
Owner

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

Isn't there a better way to allow just these warnings in clippy?
codecov[bot] commented 10 months ago (Migrated from github.com)
Owner

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
# [Codecov](https://codecov.io/gh/Plume-org/Plume/pull/727?src=pr&el=h1) Report > Merging [#727](https://codecov.io/gh/Plume-org/Plume/pull/727?src=pr&el=desc) into [master](https://codecov.io/gh/Plume-org/Plume/commit/5f8d6b8e0e81390118c4e7eef97546252bc5a7bf?src=pr&el=desc) will **decrease** coverage by `0.02%`. > The diff coverage is `n/a`. ```diff @@ 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
Sign in to join this conversation.
No reviewers
No Milestone
No Assignees
2 Participants
Notifications
Due Date

No due date set.

Dependencies

This pull request currently doesn't have any dependencies.

Loading…
There is no content yet.