diff options
| author | Manish Goregaokar <manishsmail@gmail.com> | 2021-10-01 14:46:46 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-10-01 14:46:46 -0700 |
| commit | eedc76d6ab9da25a9253ce15d42f0d5e1e9b98af (patch) | |
| tree | 0d6f5ab970dc80231ec96422b1914f3e95e804fd | |
| parent | b6057bf7b7ee7c58e6a39ead02eaa13b75f908c2 (diff) | |
| parent | 8a7bb2bb66f86f2e106b85145eae824f84da2419 (diff) | |
| download | rust-eedc76d6ab9da25a9253ce15d42f0d5e1e9b98af.tar.gz rust-eedc76d6ab9da25a9253ce15d42f0d5e1e9b98af.zip | |
Rollup merge of #85223 - simbleau:master, r=steveklabnik
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.
| -rw-r--r-- | src/doc/rustdoc/src/lints.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/src/doc/rustdoc/src/lints.md b/src/doc/rustdoc/src/lints.md index 16b091eb255..d5981dd83de 100644 --- a/src/doc/rustdoc/src/lints.md +++ b/src/doc/rustdoc/src/lints.md @@ -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() {} |
