diff options
| author | Matthias Krüger <matthias.krueger@famsik.de> | 2021-03-11 15:47:51 +0100 |
|---|---|---|
| committer | Matthias Krüger <matthias.krueger@famsik.de> | 2021-03-11 15:47:51 +0100 |
| commit | 0af90fd15a48352232d03d7f68bc4f2f2b194f5c (patch) | |
| tree | c38f545691e46490d49bcf5c9974ef5516fde783 | |
| parent | ac935781f5c7bf49a4366a63050a0e180f4a16c3 (diff) | |
| download | rust-0af90fd15a48352232d03d7f68bc4f2f2b194f5c.tar.gz rust-0af90fd15a48352232d03d7f68bc4f2f2b194f5c.zip | |
doc line length fixes
| -rw-r--r-- | doc/basics.md | 7 | ||||
| -rw-r--r-- | lintcheck/README.md | 6 |
2 files changed, 9 insertions, 4 deletions
diff --git a/doc/basics.md b/doc/basics.md index 426271db437..c56e84e2e32 100644 --- a/doc/basics.md +++ b/doc/basics.md @@ -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. diff --git a/lintcheck/README.md b/lintcheck/README.md index 983f59efdbd..52bbcc0a831 100644 --- a/lintcheck/README.md +++ b/lintcheck/README.md @@ -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. \ No newline at end of file +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. |