Skip to content

Commit

Permalink
Rollup merge of #85223 - simbleau:master, r=steveklabnik
Browse files Browse the repository at this point in the history
rustdoc: Clarified the attribute which prompts the warning

The example call was lacking clarification of the  `#![warn(rustdoc::invalid_codeblock_attributes)]` attribute which generates the specified warning.
  • Loading branch information
Manishearth authored Oct 1, 2021
2 parents b6057bf + 8a7bb2b commit eedc76d
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/doc/rustdoc/src/lints.md
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 @@ -344,6 +348,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

0 comments on commit eedc76d

Please sign in to comment.