Emit a warning on generic parameters with doc comments #91397
Merged
Conversation
This file contains 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
jyn514
added
T-rustdoc
|
r? @wesleywiser (rust-highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
jyn514
force-pushed
the
generic-param-docs
branch
from
2c4dab6 to
76f40e3
Compare
jyn514
force-pushed
the
generic-param-docs
branch
from
76f40e3 to
bd894a0
Compare
wesleywiser
approved these changes
Nov 30, 2021
|
📌 Commit bd894a0 has been approved by |
bors
added
S-waiting-on-bors
camelid
reviewed
Nov 30, 2021
Comment on lines
+29
to
+30
| fn doc_comment_on_generic<#[doc = "x"] T>(val: T) {} | ||
| //~^ ERROR: unused doc comment |
There was a problem hiding this comment.
Perhaps it's also worth adding tests for
fn doc_comment_on_generic<
/// x
T>(val: T) {}
//~^^ ERROR: unused doc commentand
fn doc_comment_on_generic</** foo */ T>(val: T) {}
//~^ ERROR: unused doc commentThere was a problem hiding this comment.
Oops, GitHub didn't show me that this was already approved.
There was a problem hiding this comment.
I don't think we need to test those, anyway - rustc represents them both as #[doc] under the hood. There are plenty of other tests that would fail if that weren't the case.
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Dec 1, 2021
…askrgr Rollup of 4 pull requests Successful merges: - rust-lang#91294 (Visit type in process_projection_elem.) - rust-lang#91340 (Bump compiler_builtins to 0.1.55 to bring in fixes for targets lackin…) - rust-lang#91366 (Only show notable traits if both types are the same) - rust-lang#91397 (Emit a warning on generic parameters with doc comments) 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
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 #90610