Skip to content

Commit c7a08c6

Browse files
committed
Note that IDENT must be a valid rust identifier.
1 parent 5bebc57 commit c7a08c6

File tree

1 file changed

+7
-13
lines changed

1 file changed

+7
-13
lines changed

text/0000-doctest-name.md

+7-13
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
# Summary
77
[summary]: #summary
88

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.
1111

1212
# Motivation
1313
[motivation]: #motivation
@@ -24,8 +24,8 @@ specific tests using `cargo test --doc -- $TEST_NAME`.
2424
# Guide-level explanation
2525
[guide-level-explanation]: #guide-level-explanation
2626

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.
2929

3030
The first set of backticks may be followed by an info string. For example, to
3131
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
5353

5454
If you'd like to have the test runner print a more informative name, perhaps
5555
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.
5758

5859

5960
````rust
@@ -80,7 +81,7 @@ The set of valid words that may appear in code block info strings is extended
8081
to include patterns of the form `name=IDENT`.
8182

8283
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.
8485

8586
When the test runner runs the documentation test, the test will be identified
8687
by this name, in addition to the test binary, module, and line number.
@@ -116,13 +117,6 @@ feature.
116117
This design seems like the simplest design possible, although viable
117118
alternatives may have been overlooked.
118119

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-
126120
The impact of adopting this RFC is minimal. Doctests test output will remain a
127121
little hard to make sense of.
128122

0 commit comments

Comments
 (0)