Skip to content

Commit

Permalink
Auto merge of #4367 - flip1995:doc_edition_2018_tests, r=phansch
Browse files Browse the repository at this point in the history
Document how to write tests requiring the 2018 edition

[Rendered](https://github.com/flip1995/rust-clippy/blob/doc_edition_2018_tests/doc/adding_lints.md#Edition-2018-tests)

cc #4365

changelog: none
  • Loading branch information
bors committed Aug 12, 2019
2 parents 7a0ac4c + 99d1cde commit ed1de3d
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions doc/adding_lints.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ because that's clearly a non-descriptive name.
* [Setup](#Setup)
* [Testing](#Testing)
* [Rustfix tests](#Rustfix-tests)
* [Edition 2018 tests](#Edition-2018-tests)
* [Lint declaration](#Lint-declaration)
* [Lint passes](#Lint-passes)
* [Emitting a lint](#Emitting-a-lint)
Expand Down Expand Up @@ -101,6 +102,12 @@ Use `tests/ui/update-all-references.sh` to automatically generate the

With tests in place, let's have a look at implementing our lint now.

### Edition 2018 tests

Some features require the 2018 edition to work (e.g. `async_await`), but
compile-test tests run on the 2015 edition by default. To change this behavior
add `// compile-flags: --edition 2018` at the top of the test file.

### Testing manually

Manually testing against an example file can be useful if you have added some
Expand Down

0 comments on commit ed1de3d

Please sign in to comment.