Clarified all attributes which prompt warnings
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.
This commit is contained in:
parent
b65bad99f7
commit
2b27c82fbb
1 changed files with 4 additions and 0 deletions
|
|
@ -70,6 +70,8 @@ This lint **warns by default**. This lint detects when [intra-doc links] from pu
|
|||
For example:
|
||||
|
||||
```rust
|
||||
#![warn(private_intra_doc_links)]
|
||||
|
||||
/// [private]
|
||||
pub fn public() {}
|
||||
fn private() {}
|
||||
|
|
@ -302,6 +304,8 @@ This lint is **warn-by-default**. It detects URLs which are not links.
|
|||
For example:
|
||||
|
||||
```rust
|
||||
#![warn(bare_urls)]
|
||||
|
||||
/// http://example.org
|
||||
/// [http://example.net]
|
||||
pub fn foo() {}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue