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.

Sign up for GitHub

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

Jump to bottom

rustdoc: Clarified the attribute which prompts the warning #85223

Merged
merged 4 commits into from
Oct 2, 2021
Merged

rustdoc: Clarified the attribute which prompts the warning #85223

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b65bad9
Clarified the attribute which prompts the warning
simbleau May 12, 2021
2b27c82
Clarified all attributes which prompt warnings
simbleau May 12, 2021
d7884d4
Noted necessessity and fixed rustdoc:: prefix
simbleau May 16, 2021
8a7bb2b
Fixed item typo which did not need prefix
simbleau May 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/doc/rustdoc/src/lints.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@ This lint **warns by default**. This lint detects when [intra-doc links] from pu
For example:

```rust
#![warn(rustdoc::private_intra_doc_links)] // note: unecessary - warns by default.

/// [private]
pub fn public() {}
fn private() {}
Expand Down Expand Up @@ -227,6 +229,8 @@ This lint **warns by default**. It detects code block attributes in
documentation examples that have potentially mis-typed values. For example:

```rust
#![warn(rustdoc::invalid_codeblock_attributes)] // note: unecessary - warns by default.

/// Example.
///
/// ```should-panic
Expand Down Expand Up @@ -300,6 +304,8 @@ This lint is **warn-by-default**. It detects URLs which are not links.
For example:

```rust
#![warn(rustdoc::bare_urls)] // note: unecessary - warns by default.

/// http://example.org
/// [http://example.net]
pub fn foo() {}
Expand Down