Skip to content

Commit 5bebc57

Browse files
committed
Use IDENT to specify that name must be an identifier
1 parent 1ccd36e commit 5bebc57

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

text/0000-doctest-name.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
[summary]: #summary
88

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

1212
# Motivation
1313
[motivation]: #motivation
@@ -52,8 +52,8 @@ test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out
5252
```
5353

5454
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.
5757

5858

5959
````rust
@@ -77,18 +77,18 @@ test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out
7777
[reference-level-explanation]: #reference-level-explanation
7878

7979
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`.
8181

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
8383
block.
8484

8585
When the test runner runs the documentation test, the test will be identified
8686
by this name, in addition to the test binary, module, and line number.
8787

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
8989
string.
9090

91-
`name=NAME` may be combined with existing annotations like `rust` or
91+
`name=IDENT` may be combined with existing annotations like `rust` or
9292
`should_panic` by separating the annotations with commas:
9393

9494
````

0 commit comments

Comments
 (0)