about summary refs log tree commit diff
diff options
context:
space:
mode:
authorSpencer Imbleau <spencer@imbleau.com>2021-05-16 12:54:53 -0400
committerGitHub <noreply@github.com>2021-05-16 12:54:53 -0400
commitd7884d4b08f0eedbdc6a3dabd0fdaa3779d393b6 (patch)
tree7322eeaba851ecf1f5def73aa5161440edee7652
parent2b27c82fbb691f6b2d3440535a13780fdf36ee23 (diff)
downloadrust-d7884d4b08f0eedbdc6a3dabd0fdaa3779d393b6.tar.gz
rust-d7884d4b08f0eedbdc6a3dabd0fdaa3779d393b6.zip
Noted necessessity and fixed rustdoc:: prefix
Now shows that certain warnings are unnecessary but includes them for consistency.
-rw-r--r--src/doc/rustdoc/src/lints.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/src/doc/rustdoc/src/lints.md b/src/doc/rustdoc/src/lints.md
index dddff0475ad..a496db600ef 100644
--- a/src/doc/rustdoc/src/lints.md
+++ b/src/doc/rustdoc/src/lints.md
@@ -70,7 +70,7 @@ This lint **warns by default**. This lint detects when [intra-doc links] from pu
 For example:
 
 ```rust
-#![warn(private_intra_doc_links)]
+#![warn(rustdoc::private_intra_doc_links)] // note: unecessary - warns by default.
 
 /// [private]
 pub fn public() {}
@@ -112,7 +112,7 @@ This lint is **allowed by default**. It detects items missing documentation.
 For example:
 
 ```rust
-#![warn(missing_docs)]
+#![warn(rustdoc::missing_docs)]
 
 pub fn undocumented() {}
 # fn main() {}
@@ -229,7 +229,7 @@ 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)]
+#![warn(rustdoc::invalid_codeblock_attributes)]  // note: unecessary - warns by default.
 
 /// Example.
 ///
@@ -304,7 +304,7 @@ This lint is **warn-by-default**. It detects URLs which are not links.
 For example:
 
 ```rust
-#![warn(bare_urls)]
+#![warn(rustdoc::bare_urls)] // note: unecessary - warns by default.
 
 /// http://example.org
 /// [http://example.net]