You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/rust-2024/rustdoc-doctests.md
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -40,7 +40,7 @@ This change is only available in the 2024 Edition to avoid potential incompatibi
40
40
41
41
[^implementation]: For more information on the details of how this work, see ["Doctests - How were they improved?"](https://blog.guillaume-gomez.fr/articles/2024-08-17+Doctests+-+How+were+they+improved%3F).
42
42
43
-
### Standalone tag
43
+
### `standalone_crate` tag
44
44
45
45
In some situations it is not possible for rustdoc to combine examples into a single executable. Rustdoc will attempt to automatically detect if this is not possible. For example, a test will not be combined with others if it:
46
46
@@ -50,7 +50,7 @@ In some situations it is not possible for rustdoc to combine examples into a sin
50
50
* Defines any crate-wide attributes (like `#![feature(...)]`).
51
51
* Defines a macro that uses `$crate`, because the `$crate` path will not work correctly.
52
52
53
-
However, rustdoc is not able to automatically determine *all* situations where an example cannot be combined with other examples. In these situations, you can add the `standalone` language tag to indicate that the example should be built as a separate executable. For example:
53
+
However, rustdoc is not able to automatically determine *all* situations where an example cannot be combined with other examples. In these situations, you can add the `standalone_crate` language tag to indicate that the example should be built as a separate executable. For example:
54
54
55
55
```rust
56
56
//! ```
@@ -59,10 +59,10 @@ However, rustdoc is not able to automatically determine *all* situations where a
59
59
//! ```
60
60
```
61
61
62
-
This is sensitive to the code structure of how the example is compiled and won't work with the "combined" approach because the line numbers will shift depending on how the doctests are combined. In these situations, you can add the `standalone` tag to force the example to be built separately just as it was in previous editions. E.g.:
62
+
This is sensitive to the code structure of how the example is compiled and won't work with the "combined" approach because the line numbers will shift depending on how the doctests are combined. In these situations, you can add the `standalone_crate` tag to force the example to be built separately just as it was in previous editions. E.g.:
63
63
64
64
```rust
65
-
//! ```standalone
65
+
//! ```standalone_crate
66
66
//! let location = std::panic::Location::caller();
67
67
//! assert_eq!(location.line(), 5);
68
68
//! ```
@@ -75,4 +75,4 @@ This is sensitive to the code structure of how the example is compiled and won't
75
75
76
76
## Migration
77
77
78
-
There is no automatic migration to determine which doctests need to be annotated with the `standalone` tag. It's very unlikely that any given doctest will not work correctly when migrated. We suggest that you update your crate to the 2024 Edition and then run your documentation tests and see if any fail. If one does, you will need to analyze whether it can be rewritten to be compatible with the combined approach, or alternatively, add the `standalone` tag to retain the previous behavior.
78
+
There is no automatic migration to determine which doctests need to be annotated with the `standalone_crate` tag. It's very unlikely that any given doctest will not work correctly when migrated. We suggest that you update your crate to the 2024 Edition and then run your documentation tests and see if any fail. If one does, you will need to analyze whether it can be rewritten to be compatible with the combined approach, or alternatively, add the `standalone_crate` tag to retain the previous behavior.
0 commit comments