7
7
[ summary ] : #summary
8
8
9
9
Allow giving documentation tests names for identification in test runner
10
- output by including ` name=NAME ` in doctest code block info strings.
10
+ output by including ` name=IDENT ` in doctest code block info strings.
11
11
12
12
# Motivation
13
13
[ motivation ] : #motivation
@@ -52,8 +52,8 @@ test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out
52
52
```
53
53
54
54
If you'd like to have the test runner print a more informative name, perhaps
55
- because there are many doctests in a single file, you can put ` name=NAME ` ,
56
- where ` NAME ` is the name the test should have, in the doctest's info string.
55
+ because there are many doctests in a single file, you can put ` name=IDENT ` ,
56
+ where ` IDENT ` is the name the test should have, in the doctest's info string.
57
57
58
58
59
59
```` rust
@@ -77,18 +77,18 @@ test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out
77
77
[ reference-level-explanation ] : #reference-level-explanation
78
78
79
79
The set of valid words that may appear in code block info strings is extended
80
- to include patterns of the form ` name=NAME ` .
80
+ to include patterns of the form ` name=IDENT ` .
81
81
82
- This ` NAME ` will be the name of the documentation test generated by the code
82
+ This ` IDENT ` will be the name of the documentation test generated by the code
83
83
block.
84
84
85
85
When the test runner runs the documentation test, the test will be identified
86
86
by this name, in addition to the test binary, module, and line number.
87
87
88
- Multiple ` name=NAME ` words may not appear in a single code block's info
88
+ Multiple ` name=IDENT ` words may not appear in a single code block's info
89
89
string.
90
90
91
- ` name=NAME ` may be combined with existing annotations like ` rust ` or
91
+ ` name=IDENT ` may be combined with existing annotations like ` rust ` or
92
92
` should_panic ` by separating the annotations with commas:
93
93
94
94
````
0 commit comments