diff options
| author | Spencer Imbleau <spencer@imbleau.com> | 2021-05-12 09:02:13 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-05-12 09:02:13 -0400 |
| commit | b65bad99f7e9c7c2d9a19a54ff385146f522082c (patch) | |
| tree | ec5a438a5c4b5768e3c75517a464887c8277da45 | |
| parent | ac923d94f86a6f7c881ecbedcd0a68d7986a35bd (diff) | |
| download | rust-b65bad99f7e9c7c2d9a19a54ff385146f522082c.tar.gz rust-b65bad99f7e9c7c2d9a19a54ff385146f522082c.zip | |
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 | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/src/doc/rustdoc/src/lints.md b/src/doc/rustdoc/src/lints.md index a6626679a7d..c494eef1b57 100644 --- a/src/doc/rustdoc/src/lints.md +++ b/src/doc/rustdoc/src/lints.md @@ -227,6 +227,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)] + /// Example. /// /// ```should-panic |