-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
Convert clippy_lints
to intra-doc links
#6412
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -39,7 +39,7 @@ use crate::utils::{ | |
|
||
declare_clippy_lint! { | ||
/// **What it does:** Checks for use of `Box<Vec<_>>` anywhere in the code. | ||
/// Check the [Box documentation](https://doc.rust-lang.org/std/boxed/index.html) for more information. | ||
/// Check the [`Box` documentation](std::boxed) for more information. | ||
/// | ||
/// **Why is this bad?** `Vec` already keeps its contents in a separate area on | ||
/// the heap. So if you `Box` it, you just add another level of indirection | ||
|
@@ -68,7 +68,7 @@ declare_clippy_lint! { | |
|
||
declare_clippy_lint! { | ||
/// **What it does:** Checks for use of `Vec<Box<T>>` where T: Sized anywhere in the code. | ||
/// Check the [Box documentation](https://doc.rust-lang.org/std/boxed/index.html) for more information. | ||
/// Check the [`Box` documentation](std::boxed) for more information. | ||
/// | ||
/// **Why is this bad?** `Vec` already keeps its contents in a separate area on | ||
/// the heap. So if you `Box` its contents, you just add another level of indirection. | ||
|
@@ -171,7 +171,7 @@ declare_clippy_lint! { | |
|
||
declare_clippy_lint! { | ||
/// **What it does:** Checks for use of `&Box<T>` anywhere in the code. | ||
/// Check the [Box documentation](https://doc.rust-lang.org/std/boxed/index.html) for more information. | ||
/// Check the [`Box` documentation](std::boxed) for more information. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Will these links also work on https://rust-lang.github.io/rust-clippy/? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm not sure, how is that documentation built? If you're using mdbook then it won't work. I guess there's not much point to the PR then :/ There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. mdbook? You wish! We're still using our good ol' python script. 😄 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. So yeah... I don't think we can change this in our lint documentation.. |
||
/// | ||
/// **Why is this bad?** Any `&Box<T>` can also be a `&T`, which is more | ||
/// general. | ||
|
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.