Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a help message to unused_doc_comments lint #86813

Merged
merged 1 commit into from
Jul 2, 2021

Conversation

JohnTitor
Copy link
Member

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_else case, but I came to the conclusion that it unlikely happened and was an overkill.

@rust-highfive
Copy link
Collaborator

r? @jackh726

(rust-highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jul 2, 2021
Copy link
Member

@jackh726 jackh726 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like a test case for the /* */ output please. Other than that r=me

@JohnTitor
Copy link
Member Author

You can see it on src/test/ui/unused/useless-comment.stderr, isn't it enough?

@jackh726
Copy link
Member

jackh726 commented Jul 2, 2021

Missed that.

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Jul 2, 2021

📌 Commit 086eb47 has been approved by jackh726

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jul 2, 2021
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
@bors bors merged commit 1b13632 into rust-lang:master Jul 2, 2021
@rustbot rustbot added this to the 1.55.0 milestone Jul 2, 2021
@JohnTitor JohnTitor deleted the unused-doc-comments-help branch July 2, 2021 22:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Doc comments causing build errors
5 participants