Plume/Plume

Fork 24

Add warning for missing documentation #727

Closed

elegaanz wants to merge 3 commits from missing-docs into master

elegaanz commented

2020-01-21 16:43:44 +00:00

(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 2020-01-21 18:49:48 +00:00

trinity-1686a left a comment

Owner

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

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

2020-01-21 19:33:36 +00:00

(Migrated from github.com)

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

can't we add that that somewhere to `clippy` or `check`?

elegaanz commented

2020-01-22 20:11:34 +00:00

(Migrated from github.com)

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

codecov[bot] commented

2020-01-31 07:26:06 +00:00

(Migrated from github.com)

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

KitaitiMakoto closed this pull request

2021-09-05 04:50:50 +00:00

Pull request closed

This pull request cannot be reopened because the branch was deleted.

No reviewers

No milestone

No project

No assignees

2 participants

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: Plume/Plume#727

No description provided.

Rows
Columns