about summary refs log tree commit diff
path: root/src/doc/rustdoc
diff options
context:
space:
mode:
authorUrgau <urgau@numericable.fr>2025-05-05 22:50:40 +0200
committerUrgau <urgau@numericable.fr>2025-05-22 20:12:50 +0200
commit316e62a05855d80c6800dac3437414f7675afbc9 (patch)
tree6aa2088fff12501808a2bfbff15989563fde427c /src/doc/rustdoc
parent041d95d4dca9f31c4abf6938bb5eb1d893917e5b (diff)
Allow `#![doc(test(attr(..)))]` at every level
Diffstat (limited to 'src/doc/rustdoc')
-rw-r--r--src/doc/rustdoc/src/write-documentation/the-doc-attribute.md51
1 files changed, 23 insertions, 28 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 afbcf4000c5..a70861faa76 100644
--- a/src/doc/rustdoc/src/write-documentation/the-doc-attribute.md
+++ b/src/doc/rustdoc/src/write-documentation/the-doc-attribute.md
@@ -141,34 +141,6 @@ But if you include this:
 
 it will not.
 
-## At the module level
-
-These forms of the `#[doc]` attribute are used on individual modules, to control how
-they are documented.
-
-### `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 have dead code, you could add this:
-
-```rust,no_run
-#![doc(test(attr(deny(dead_code))))]
-
-mod my_mod {
-    #![doc(test(attr(allow(dead_code))))] // but allow `dead_code` for this module
-}
-```
-
-`test(attr(..))` attributes are appended to the parent module's, they do not replace the current
-list of attributes. In the previous example, both attributes would be present:
-
-```rust,no_run
-// For every doctest in `my_mod`
-
-#![deny(dead_code)] // from the crate-root
-#![allow(dead_code)] // from `my_mod`
-```
-
 ## At the item level
 
 These forms of the `#[doc]` attribute are used on individual items, to control how
@@ -300,3 +272,26 @@ To get around this limitation, we just add `#[doc(alias = "lib_name_do_something
 on the `do_something` method and then it's all good!
 Users can now look for `lib_name_do_something` in our crate directly and find
 `Obj::do_something`.
+
+### `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 have dead code, you could add this:
+
+```rust,no_run
+#![doc(test(attr(deny(dead_code))))]
+
+mod my_mod {
+    #![doc(test(attr(allow(dead_code))))] // but allow `dead_code` for this module
+}
+```
+
+`test(attr(..))` attributes are appended to the parent module's, they do not replace the current
+list of attributes. In the previous example, both attributes would be present:
+
+```rust,no_run
+// For every doctest in `my_mod`
+
+#![deny(dead_code)] // from the crate-root
+#![allow(dead_code)] // from `my_mod`
+```