user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

book: indicate that at least one error marker is required

Browse source 
This is a recent change, and no error marker is inserted by default in
the file generated by `cargo dev new_lint`.
This commit is contained in:
Samuel Tardieu 2025-04-11 10:00:44 +02:00
parent 0cd5b6261a
commit dd21b6ecea
1 changed files with 8 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

12
book/src/development/adding_lints.md
View file

@ -126,10 +126,14 @@ fn main() {
```
Note that we are adding comment annotations with the name of our lint to mark
lines where we expect an error. Once we have implemented our lint we can run
`TESTNAME=foo_functions cargo uibless` to generate the `.stderr` file. If our
lint makes use of structured suggestions then this command will also generate
the corresponding `.fixed` file.
lines where we expect an error. Except for very specific situations
(`//@check-pass`), at least one error marker must be present in a test file for
it to be accepted.
Once we have implemented our lint we can run `TESTNAME=foo_functions cargo
uibless` to generate the `.stderr` file. If our lint makes use of structured
suggestions then this command will also generate the corresponding `.fixed`
file.
While we are working on implementing our lint, we can keep running the UI test.
That allows us to check if the output is turning into what we want by checking the