-
Notifications
You must be signed in to change notification settings - Fork 12.7k
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
rustdoc: Clarified the attribute which prompts the warning #85223
Conversation
The example call was lacking clarification of the `#![warn(rustdoc::invalid_codeblock_attributes)]` attribute which generates the specified warning.
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @steveklabnik (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. Please see the contribution instructions for more information. |
It already shows it here: https://github.com/rust-lang/rust/pull/85223/files#diff-13b2c983ddb283f6812f85647105aaa7a89f2a697890095f02b9bbf82cf033ffR253 Also, i don't think we should do this just this one lint, either all of them should have |
This is one of 2 outliers without the attribute specified to the user. Every other example specifies the exact attribute in the examples given. It seems more verbose to the user, especially to notify users of the prepend |
All calls which trigger rustdoc warnings and are now properly verbose for consistency. This uses the attribute in the examples which provides the user with more context.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You said
This is one of 2 outliers without the attribute specified to the user. Every other example specifies the exact attribute in the examples given.
But that doesn't seem to be true? The only attributes I see are for demonstrating how to allow/warn/deny, or for turning on lints that are allowed by default.
Now shows that certain warnings are unnecessary but includes them for consistency.
What you said is true; I included them for clarity but the attribs are unnecessary due to their defaults. Please review. |
I don't have time to finish this up, but @steveklabnik is assigned and he's a good reviewer for this :) |
@steveklabnik any updates? |
Ping from triage: |
Ping again from triage: |
Hi! So sorry, I don't know why but GitHub did not place this into my "reviews requested" notifications, and so I didn't realize I was the reviewer here. @bors: r+ rollup |
📌 Commit 8a7bb2b has been approved by |
…arth Rollup of 7 pull requests Successful merges: - rust-lang#85223 (rustdoc: Clarified the attribute which prompts the warning) - rust-lang#88847 (platform-support.md: correct ARMv7+MUSL platform triple notes) - rust-lang#88963 (Coerce const FnDefs to implement const Fn traits ) - rust-lang#89376 (Fix use after drop in self-profile with llvm events) - rust-lang#89422 (Replace whitespaces in doctests' name with dashes) - rust-lang#89440 (Clarify a sentence in the documentation of Vec (rust-lang#84488)) - rust-lang#89441 (Normalize after substituting via `field.ty()`) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
Fix typos in rustdoc/lints This PR merely fixes a few typos in a recently introduced change :) Refs: rust-lang#85223
Fix typos in rustdoc/lints This PR merely fixes a few typos in a recently introduced change :) Refs: rust-lang#85223
…arth Rollup of 7 pull requests Successful merges: - rust-lang#85223 (rustdoc: Clarified the attribute which prompts the warning) - rust-lang#88847 (platform-support.md: correct ARMv7+MUSL platform triple notes) - rust-lang#88963 (Coerce const FnDefs to implement const Fn traits ) - rust-lang#89376 (Fix use after drop in self-profile with llvm events) - rust-lang#89422 (Replace whitespaces in doctests' name with dashes) - rust-lang#89440 (Clarify a sentence in the documentation of Vec (rust-lang#84488)) - rust-lang#89441 (Normalize after substituting via `field.ty()`) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
The example call was lacking clarification of the
#![warn(rustdoc::invalid_codeblock_attributes)]
attribute which generates the specified warning.