Add warning for missing documentation #727

Stängd

elegaanz vill sammanfoga 3 incheckningar från s[2]s in i master

elegaanz kommenterad (Migrerad från 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 granskad av

trinity-1686a lämnade en kommentar

Ägare

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 kommenterad (Migrerad från 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 kommenterad (Migrerad från github.com)

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

codecov[bot] kommenterad (Migrerad från 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

Denna pull-förfrågan kan inte öppnas igen eftersom branchen tagits bort.

You can also view command line instructions.

Step 1:

From your project repository, check out a new branch and test the changes.

git checkout -b missing-docs master

git pull origin missing-docs

Step 2:

Merge the changes and update on Forgejo.

git checkout master

git merge --no-ff missing-docs

git push origin master

Logga in för att delta i denna konversation.

Inga granskare

Ingen Milsten

Ingen tilldelad

2 Deltagare

Notiser

Förfallodatum

Förfallodatumet är ogiltigt eller utanför gränserna. Använd formatet 'åååå-mm-dd'.

Inget förfallodatum satt.

Beroenden

No dependencies set.

Laddar…

Det finns inget innehåll än.

Etiketter Milstenar

Add warning for missing documentation #727

Codecov Report

Step 1:

Step 2: