Skip to content

Commit 0722dbc

Browse files
authored
Align advice to discourage issue-number-only names
https://rustc-dev-guide.rust-lang.org/tests/best-practices.html#test-naming specifically asks devs to "Avoid using only issue numbers as test names". This commit introduces a minor change to https://rustc-dev-guide.rust-lang.org/tests/compiletest.html#crashes-tests that changes the advice to use only issue numbers as names to the advice to append them at the end of the file name.
1 parent cdc10f0 commit 0722dbc

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

src/tests/compiletest.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -565,8 +565,8 @@ $ COMPILETEST_VERBOSE_CRASHES=1 ./x test tests/crashes/999999.rs --stage 1
565565
```
566566

567567
When adding crashes from <https://github.com/rust-lang/rust/issues>, the issue
568-
number should be noted in the file name (`12345.rs` should suffice) and also
569-
inside the file include a `//@ known-bug: #4321` directive.
568+
number should be appended to the end of the file name (e.g. `calling-undefined-fn-12345.rs`).
569+
Also, include a `//@ known-bug: #12345` directive inside the file.
570570

571571
If you happen to fix one of the crashes, please move it to a fitting
572572
subdirectory in `tests/ui` and give it a meaningful name. Please add a doc

0 commit comments

Comments
 (0)