6
6
# Summary
7
7
[ summary ] : #summary
8
8
9
- Allow giving documentation tests names for identification in test runner
10
- output by including ` name=IDENT ` in doctest code block info strings.
9
+ Allow giving documentation tests names for identification in test runner output
10
+ by including ` name=IDENT ` in doctest code block info strings.
11
11
12
12
# Motivation
13
13
[ motivation ] : #motivation
@@ -24,8 +24,8 @@ specific tests using `cargo test --doc -- $TEST_NAME`.
24
24
# Guide-level explanation
25
25
[ guide-level-explanation ] : #guide-level-explanation
26
26
27
- Doctests are written as fenced markdown code blocks that start and end
28
- with lines containing three backticks.
27
+ Doctests are written as fenced markdown code blocks that start and end with
28
+ lines containing three backticks.
29
29
30
30
The first set of backticks may be followed by an info string. For example, to
31
31
tell the Rust compiler to ignore the doctest:
@@ -53,7 +53,8 @@ test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out
53
53
54
54
If you'd like to have the test runner print a more informative name, perhaps
55
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.
56
+ where ` IDENT ` is the name the test should have, which must be an identifier, in
57
+ the doctest's info string.
57
58
58
59
59
60
```` rust
@@ -80,7 +81,7 @@ The set of valid words that may appear in code block info strings is extended
80
81
to include patterns of the form ` name=IDENT ` .
81
82
82
83
This ` IDENT ` will be the name of the documentation test generated by the code
83
- block.
84
+ block, and must be a valid Rust identifier .
84
85
85
86
When the test runner runs the documentation test, the test will be identified
86
87
by this name, in addition to the test binary, module, and line number.
@@ -116,13 +117,6 @@ feature.
116
117
This design seems like the simplest design possible, although viable
117
118
alternatives may have been overlooked.
118
119
119
- A previous version of this RFC included the additional restrictions that labels
120
- must be valid rust identifiers, and that labels must be unique within the same
121
- module. These restrictions were intended to allow the machinery that generates
122
- doctest tests to use the labels as the generated doctest function names. If
123
- this simplifies or improves the generated doctest functions, these restrictions
124
- might be desirable.
125
-
126
120
The impact of adopting this RFC is minimal. Doctests test output will remain a
127
121
little hard to make sense of.
128
122
0 commit comments