Skip to content

Commit 0bc745d

Browse files
committed
Document configurations in table and paragraphs
Signed-off-by: Tyler Weaver <maybe@tylerjw.dev>
1 parent 2e2ae68 commit 0bc745d

File tree

4 files changed

+549
-79
lines changed

4 files changed

+549
-79
lines changed

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -196,11 +196,10 @@ avoid-breaking-exported-api = false
196196
disallowed-names = ["toto", "tata", "titi"]
197197
```
198198

199-
See the [list of configurable lints](https://rust-lang.github.io/rust-clippy/master/index.html#Configuration),
200-
the lint descriptions contain the names and meanings of these configuration variables.
201-
202-
See [table of lint configurations](https://doc.rust-lang.org/nightly/clippy/lint_configuration.html)
203-
to see what configuration options you can set and the lints they configure.
199+
The [table of configurations](https://doc.rust-lang.org/nightly/clippy/lint_configuration.html)
200+
contains all config values, their default, and a list of lints they affect.
201+
Each [configurable lint](https://rust-lang.github.io/rust-clippy/master/index.html#Configuration)
202+
, also contains information about these values.
204203

205204
For configurations that are a list type with default values such as
206205
[disallowed-names](https://rust-lang.github.io/rust-clippy/master/index.html#disallowed_names),

book/src/configuration.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,10 @@ avoid-breaking-exported-api = false
1010
disallowed-names = ["toto", "tata", "titi"]
1111
```
1212

13-
See the [list of configurable lints](https://rust-lang.github.io/rust-clippy/master/index.html#Configuration),
14-
the lint descriptions contain the names and meanings of these configuration variables.
15-
16-
See [table of lint configurations](./lint_configuration.md)
17-
to see what configuration options you can set and the lints they configure.
13+
The [table of configurations](./lint_configuration.md)
14+
contains all config values, their default, and a list of lints they affect.
15+
Each [configurable lint](https://rust-lang.github.io/rust-clippy/master/index.html#Configuration)
16+
, also contains information about these values.
1817

1918
For configurations that are a list type with default values such as
2019
[disallowed-names](https://rust-lang.github.io/rust-clippy/master/index.html#disallowed_names),

0 commit comments

Comments
 (0)