Skip to content

Commit 11edf92

Browse files
committed
Auto merge of rust-lang#6639 - xFrednet:0000-configuration-documentation-some-nits, r=flip1995
Updated some NITs in the documentation from rust-lang#6630 I've implemented the two suggestions from rust-lang#6630 that were added after the merge. This PR also changes the example code to use `register_*_pass` instead of `register_late_pass`. I'm not sure if this is better or worse, but it makes it clearer in my opinion. Let me know if I should change it back. --- changelog: none r? `@flip1995`
2 parents 9fd4f3e + a2d2aee commit 11edf92

File tree

3 files changed

+11
-10
lines changed

3 files changed

+11
-10
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,12 @@ first read the [Basics docs](doc/basics.md).**
4646

4747
### Finding something to fix/improve
4848

49-
All issues on Clippy are mentored, if you want help with a bug just ask
50-
@Manishearth, @flip1995, @phansch or @yaahc.
49+
All issues on Clippy are mentored, if you want help simply ask @Manishearth, @flip1995, @phansch
50+
or @llogiq directly by mentioning them in the issue or over on [Zulip]. This list may be out of date.
51+
All currently active mentors can be found [here](https://github.com/rust-lang/highfive/blob/master/highfive/configs/rust-lang/rust-clippy.json#L3)
5152

52-
Some issues are easier than others. The [`good-first-issue`] label can be used to find the easy issues.
53-
If you want to work on an issue, please leave a comment so that we can assign it to you!
53+
Some issues are easier than others. The [`good-first-issue`] label can be used to find the easy
54+
issues. You can use `@rustbot claim` to assign the issue to yourself.
5455

5556
There are also some abandoned PRs, marked with [`S-inactive-closed`].
5657
Pretty often these PRs are nearly completed and just need some extra steps

doc/adding_lints.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -581,15 +581,15 @@ in the following steps:
581581
3. Passing the configuration value to the lint impl struct:
582582

583583
First find the struct construction in the [clippy_lints lib file](/clippy_lints/src/lib.rs).
584-
Make sure that `clippy dev update_lints` added it beforehand. The configuration value is now
585-
cloned or copied into a local value that is then passed to the impl struct like this:
584+
The configuration value is now cloned or copied into a local value that is then passed to the
585+
impl struct like this:
586586
```rust
587587
// Default generated registration:
588-
store.register_late_pass(|| box module::StructName);
588+
store.register_*_pass(|| box module::StructName);
589589

590590
// New registration with configuration value
591591
let configuration_ident = conf.configuration_ident.clone();
592-
store.register_late_pass(move || box module::StructName::new(configuration_ident));
592+
store.register_*_pass(move || box module::StructName::new(configuration_ident));
593593
```
594594

595595
Congratulations the work is almost done. The configuration value can now be accessed
@@ -599,7 +599,7 @@ in the following steps:
599599
1. The default configured value can be tested like any normal lint in [`tests/ui`](/tests/ui).
600600
2. The configuration itself will be tested separately in [`tests/ui-toml`](/tests/ui-toml).
601601
Simply add a new subfolder with a fitting name. This folder contains a `clippy.toml` file
602-
with the configuration value and a rust file that should be linted by clippy. The test can
602+
with the configuration value and a rust file that should be linted by Clippy. The test can
603603
otherwise be written as usual.
604604

605605
## Cheatsheet

doc/basics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ See <https://rustc-dev-guide.rust-lang.org/contributing.html#opening-a-pr>.
109109
| HIR | High-Level Intermediate Representation |
110110
| TCX | Type context |
111111

112-
This is a concise list of abbreviations that can come up during clippy development. An extensive
112+
This is a concise list of abbreviations that can come up during Clippy development. An extensive
113113
general list can be found in the [rustc-dev-guide glossary][glossary]. Always feel free to ask if
114114
an abbreviation or meaning is unclear to you.
115115

0 commit comments

Comments
 (0)