about summary refs log tree commit diff
path: root/src/doc/rustdoc
diff options
context:
space:
mode:
authorUrgau <urgau@numericable.fr>2024-06-19 13:08:26 +0200
committerUrgau <urgau@numericable.fr>2024-06-19 13:08:26 +0200
commitd70d76b9e7cd80b01797b433dd2baf7a6720e21e (patch)
treee345ce5700a1c10320bd907903ea1cde92d1be37 /src/doc/rustdoc
parente23ae72ac7a393961886ea62df065ebb6def7d51 (diff)
downloadrust-d70d76b9e7cd80b01797b433dd2baf7a6720e21e.tar.gz
rust-d70d76b9e7cd80b01797b433dd2baf7a6720e21e.zip
Rework doc-test attribute documentation example
Diffstat (limited to 'src/doc/rustdoc')
-rw-r--r--src/doc/rustdoc/src/write-documentation/the-doc-attribute.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/src/doc/rustdoc/src/write-documentation/the-doc-attribute.md b/src/doc/rustdoc/src/write-documentation/the-doc-attribute.md
index 669dc9358eb..ff033aa14b8 100644
--- a/src/doc/rustdoc/src/write-documentation/the-doc-attribute.md
+++ b/src/doc/rustdoc/src/write-documentation/the-doc-attribute.md
@@ -144,10 +144,10 @@ it will not.
 ### `test(attr(...))`
 
 This form of the `doc` attribute allows you to add arbitrary attributes to all your doctests. For
-example, if you want your doctests to fail if they produce any warnings, you could add this:
+example, if you want your doctests to fail if they have dead code, you could add this:
 
 ```rust,no_run
-#![doc(test(attr(deny(warnings))))]
+#![doc(test(attr(deny(dead_code))))]
 ```
 
 ## At the item level