Add warning for missing documentation #727

zavřený

elegaanz chce sloučit 3 commity z větve missing-docs do master

elegaanz okomentoval (Migrováno z 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 posoudil

trinity-1686a zanechal komentář

Vlastník

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 okomentoval (Migrováno z 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 okomentoval (Migrováno z github.com)

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

codecov[bot] okomentoval (Migrováno z 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 uzavřel/a tento požadavek na natažení

Tento požadavek na natažení nemůže být znovu otevřen protože větev byla smazána.

Můžete také zobrazit instrukce příkazové řádky.

Krok 1:

Z vašeho repositáře projektu se podívejte na novou větev a vyzkoušejte změny.

git checkout -b missing-docs master

git pull origin missing-docs

Krok 2:

Slučte změny a aktualizujte je na Forgejo.

git checkout master

git merge --no-ff missing-docs

git push origin master

Přihlaste se pro zapojení do konverzace.

Žádní posuzovatelé

Bez milníku

Bez zpracovatelů

2 účastníků

Oznámení

Termín dokončení

Termín dokončení není platný nebo je mimo rozsah. Použijte prosím formát „rrrr-mm-dd“.

Žádný termín dokončení.

Závislosti

Nejsou nastaveny žádné závislosti.

Načítá se…

Není zde žádný obsah.

Štítky Milníky

Add warning for missing documentation #727

Codecov Report

Krok 1:

Krok 2: