squiid/rust
1
0
Fork 0
Code Issues Pull requests Projects Activity

doc line length fixes

Browse source
This commit is contained in:
Matthias Krüger 2021-03-11 15:47:51 +01:00
parent ac935781f5
commit 0af90fd15a
2 changed files with 9 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
doc/basics.md
View file

@ -93,8 +93,11 @@ cargo dev ra_setup
```
## lintcheck
`cargo lintcheck` will build and run clippy on a fixed set of crates and generate a log of the results. You can `git diff` the updated log against its previous version and see what impact your lint made on a small set of crates.
If you add a new lint, please audit the resulting warnings and make sure there are no false positives and that the suggestions are valid.
`cargo lintcheck` will build and run clippy on a fixed set of crates and generate a log of the results.
You can `git diff` the updated log against its previous version and
see what impact your lint made on a small set of crates.
If you add a new lint, please audit the resulting warnings and make sure
there are no false positives and that the suggestions are valid.
Refer to the tools [README] for more details.

6
lintcheck/README.md
View file

@ -69,7 +69,9 @@ is checked.
is explicitly specified in the options.
### Fix mode
You can run `./lintcheck/target/debug/lintcheck --fix` which will run Clippy with `-Zunstable-options --fix` and print a warning if Clippys suggestions fail to apply (if the resulting code does not build).
You can run `./lintcheck/target/debug/lintcheck --fix` which will run Clippy with `-Zunstable-options --fix` and
print a warning if Clippys suggestions fail to apply (if the resulting code does not build).
This lets us spot bad suggestions or false positives automatically in some cases.
Please note that the target dir should be cleaned afterwards since clippy will modify the downloaded sources which can lead to unexpected results when running lintcheck again afterwards.
Please note that the target dir should be cleaned afterwards since clippy will modify
the downloaded sources which can lead to unexpected results when running lintcheck again afterwards.