Add a help message to unused_doc_comments lint #86813
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Contributor
| r? @jackh726 (rust-highfive has picked a reviewer for you, use r? to override) |
rust-highfive added the S-waiting-on-review 
jackh726 requested changes Jul 2, 2021
Member
jackh726 left a comment
jackh726 left a comment There was a problem hiding this comment.
I'd like a test case for the /* */ output please. Other than that r=me
Member Author
| You can see it on |
Member
| Missed that. @bors r+ rollup |
Collaborator
| 📌 Commit 086eb47 has been approved by |
bors added S-waiting-on-bors 
bors added a commit to rust-lang-ci/rust that referenced this pull request Jul 2, 2021
Rollup of 7 pull requests Successful merges: - rust-lang#84029 (add `track_path::path` fn for usage in `proc_macro`s) - rust-lang#85001 (Merge `sys_common::bytestring` back into `os_str_bytes`) - rust-lang#86308 (Docs: clarify that certain intrinsics are not unsafe) - rust-lang#86796 (Add a regression test for issue-70703) - rust-lang#86803 (Remove & from Command::args calls in documentation) - rust-lang#86807 (Fix double import in wasm thread ) - rust-lang#86813 (Add a help message to `unused_doc_comments` lint) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
Fixes #83492
This adds a help message to suggest a plain comment like the E0658 error. I've yet to come up with the best message about the doc attribute but the current shouldn't harm anything.
I was thinking of recovering in the
doc_comment_between_if_elsecase, but I came to the conclusion that it unlikely happened and was an overkill.