Skip to content

Commit

Permalink
doc line length fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
matthiaskrgr committed Mar 11, 2021
1 parent ac93578 commit 0af90fd
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 4 deletions.
7 changes: 5 additions & 2 deletions doc/basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
6 changes: 4 additions & 2 deletions lintcheck/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 0af90fd

Please sign in to comment.