Add warning for missing documentation #727

닫힘
elegaanz missing-docs 에서 master 로 3 commits 를 머지하려 합니다
elegaanz 코멘트됨, 4 년 전 (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 검토됨 4 년 전
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

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 코멘트됨, 4 년 전 (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 코멘트됨, 4 년 전 (Migrated from github.com)

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] 코멘트됨, 4 년 전 (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 3 년 전
This pull request cannot be reopened because the branch was deleted.
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
로그인하여 이 대화에 참여
No reviewers
마일스톤 없음
담당자 없음
참여자 2명
알림
마감일
기한이 올바르지 않거나 범위를 벗어났습니다. 'yyyy-mm-dd'형식을 사용해주십시오.

마감일이 설정되지 않았습니다.

의존성

No dependencies set.

Reference: Plume/Plume#727
불러오는 중...
아직 콘텐츠가 없습니다.