mathieu/os-rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Rollup merge of #85223 - simbleau:master, r=steveklabnik

Browse source 
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.
This commit is contained in:
Manish Goregaokar 2021-10-01 14:46:46 -07:00 • committed by GitHub
commit eedc76d6ab
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
src/doc/rustdoc/src/lints.md
View file

@ -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() {}
@ -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
@ -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() {}