Add warning for missing documentation #727

クローズ

elegaanz が missing-docs から master への 3 コミットのマージを希望しています

elegaanz がコメント (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 がレビュー

trinity-1686a がコメント

オーナー

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 がコメント (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 がコメント (github.comから移行)

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

codecov[bot] がコメント (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 がプルリクエストをクローズ

このプルリクエストはブランチが削除されているため、再オープンできません。

コマンドラインの手順も確認できます。

ステップ 1:

あなたのプロジェクトリポジトリで新しいブランチをチェックアウトし、変更内容をテストします。

git checkout -b missing-docs master

git pull origin missing-docs

ステップ 2:

変更内容をマージして、Forgejoに反映します。

git checkout master

git merge --no-ff missing-docs

git push origin master

サインインしてこの会話に参加。

レビューアなし

マイルストーンなし

担当者なし

2 人の参加者

通知

期日

期日が正しくないか範囲を超えています。 'yyyy-mm-dd' の形式で入力してください。

期日は未設定です。

依存関係

依存関係が設定されていません。

読み込み中…

まだ内容がありません

ラベル マイルストーン

Add warning for missing documentation #727

Codecov Report

ステップ 1:

ステップ 2:

ラベルマイルストーン