Skip to content

Commit eedc76d

Browse files
authored
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.
2 parents b6057bf + 8a7bb2b commit eedc76d

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/doc/rustdoc/src/lints.md

+6
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,8 @@ This lint **warns by default**. This lint detects when [intra-doc links] from pu
7070
For example:
7171

7272
```rust
73+
#![warn(rustdoc::private_intra_doc_links)] // note: unecessary - warns by default.
74+
7375
/// [private]
7476
pub fn public() {}
7577
fn private() {}
@@ -227,6 +229,8 @@ This lint **warns by default**. It detects code block attributes in
227229
documentation examples that have potentially mis-typed values. For example:
228230

229231
```rust
232+
#![warn(rustdoc::invalid_codeblock_attributes)] // note: unecessary - warns by default.
233+
230234
/// Example.
231235
///
232236
/// ```should-panic
@@ -344,6 +348,8 @@ This lint is **warn-by-default**. It detects URLs which are not links.
344348
For example:
345349

346350
```rust
351+
#![warn(rustdoc::bare_urls)] // note: unecessary - warns by default.
352+
347353
/// http://example.org
348354
/// [http://example.net]
349355
pub fn foo() {}

0 commit comments

Comments
 (0)