Skip to content

Commit 5d568ad

Browse files
committed
Auto merge of #12885 - lochetti:clippy_proper_noun, r=flip1995
Using Clippy as a proper noun when refering to the unique entity Clippy I was reading some documentation (specially the book) and I notice some few usages of the word `clippy` when refering to the Project/Tool. As we already have in the majority of the documentation, in those cases, Clippy is a proper noun, and because of that should be used capitalized. This is, for sure, not an exhaustive change: quite the opposity, it was just some cases that I could verify with not so much effort. changelog: Docs: capitalizing the `clippy` word in some usages.
2 parents 4f3180a + 9173c58 commit 5d568ad

File tree

8 files changed

+17
-17
lines changed

8 files changed

+17
-17
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ You can add options to your code to `allow`/`warn`/`deny` Clippy lints:
172172

173173
Note: `allow` means to suppress the lint for your code. With `warn` the lint
174174
will only emit a warning, while with `deny` the lint will emit an error, when
175-
triggering for your code. An error causes clippy to exit with an error code, so
175+
triggering for your code. An error causes Clippy to exit with an error code, so
176176
is useful in scripts like CI/CD.
177177

178178
If you do not want to include your lint levels in your code, you can globally
@@ -238,7 +238,7 @@ define the `CLIPPY_DISABLE_DOCS_LINKS` environment variable.
238238
### Specifying the minimum supported Rust version
239239

240240
Projects that intend to support old versions of Rust can disable lints pertaining to newer features by
241-
specifying the minimum supported Rust version (MSRV) in the clippy configuration file.
241+
specifying the minimum supported Rust version (MSRV) in the Clippy configuration file.
242242

243243
```toml
244244
msrv = "1.30.0"

book/src/configuration.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ For more details and options, refer to the Cargo documentation.
9999
### Specifying the minimum supported Rust version
100100

101101
Projects that intend to support old versions of Rust can disable lints pertaining to newer features by specifying the
102-
minimum supported Rust version (MSRV) in the clippy configuration file.
102+
minimum supported Rust version (MSRV) in the Clippy configuration file.
103103

104104
```toml
105105
msrv = "1.30.0"

book/src/development/basics.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ More about [intellij] command usage and reasons.
107107

108108
## lintcheck
109109

110-
`cargo lintcheck` will build and run clippy on a fixed set of crates and
110+
`cargo lintcheck` will build and run Clippy on a fixed set of crates and
111111
generate a log of the results. You can `git diff` the updated log against its
112112
previous version and see what impact your lint made on a small set of crates.
113113
If you add a new lint, please audit the resulting warnings and make sure there

book/src/development/defining_lints.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -163,11 +163,11 @@ declare_clippy_lint! {
163163
///
164164
/// ### Example
165165
/// ```rust
166-
/// // example code where clippy issues a warning
166+
/// // example code where Clippy issues a warning
167167
/// ```
168168
/// Use instead:
169169
/// ```rust
170-
/// // example code which does not raise clippy warning
170+
/// // example code which does not raise Clippy warning
171171
/// ```
172172
#[clippy::version = "1.70.0"] // <- In which version was this implemented, keep it up to date!
173173
pub LINT_NAME, // <- The lint name IN_ALL_CAPS

book/src/development/proposals/syntax-tree-patterns.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -428,7 +428,7 @@ selection of possible matches is produced by the pattern syntax. In the second
428428
stage, the named subpattern references can be used to do additional tests like
429429
asserting that a node hasn't been created as part of a macro expansion.
430430

431-
## Implementing clippy lints using patterns
431+
## Implementing Clippy lints using patterns
432432

433433
As a "real-world" example, I re-implemented the `collapsible_if` lint using
434434
patterns. The code can be found
@@ -572,7 +572,7 @@ The pattern syntax and the *PatternTree* are independent of specific syntax tree
572572
implementations (rust ast / hir, syn, ...). When looking at the different
573573
pattern examples in the previous sections, it can be seen that the patterns
574574
don't contain any information specific to a certain syntax tree implementation.
575-
In contrast, clippy lints currently match against ast / hir syntax tree nodes
575+
In contrast, Clippy lints currently match against ast / hir syntax tree nodes
576576
and therefore directly depend on their implementation.
577577

578578
The connection between the *PatternTree* and specific syntax tree
@@ -690,7 +690,7 @@ change, only the `IsMatch` trait implementations need to be adapted and existing
690690
lints can remain unchanged. This also means that if the `IsMatch` trait
691691
implementations were integrated into the compiler, updating the `IsMatch`
692692
implementations would be required for the compiler to compile successfully. This
693-
could reduce the number of times clippy breaks because of changes in the
693+
could reduce the number of times Clippy breaks because of changes in the
694694
compiler. Another advantage of the pattern's independence is that converting an
695695
`EarlyLintPass` lint into a `LatePassLint` wouldn't require rewriting the whole
696696
pattern matching code. In fact, the pattern might work just fine without any
@@ -777,7 +777,7 @@ complexity to solve a relatively minor problem.
777777

778778
The issue of users not knowing about the *PatternTree* structure could be solved
779779
by a tool that, given a rust program, generates a pattern that matches only this
780-
program (similar to the clippy author lint).
780+
program (similar to the Clippy author lint).
781781

782782
For some simple cases (like the first example above), it might be possible to
783783
successfully mix Rust and pattern syntax. This space could be further explored
@@ -789,7 +789,7 @@ The pattern syntax is heavily inspired by regular expressions (repetitions,
789789
alternatives, sequences, ...).
790790

791791
From what I've seen until now, other linters also implement lints that directly
792-
work on syntax tree data structures, just like clippy does currently. I would
792+
work on syntax tree data structures, just like Clippy does currently. I would
793793
therefore consider the pattern syntax to be *new*, but please correct me if I'm
794794
wrong.
795795

@@ -982,5 +982,5 @@ pattern!{
982982
}
983983
```
984984

985-
In the future, clippy could use this system to also provide lints for custom
985+
In the future, Clippy could use this system to also provide lints for custom
986986
syntaxes like those found in macros.

clippy_dummy/PUBLISH.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
This is a dummy crate to publish to crates.io. It primarily exists to ensure
2-
that folks trying to install clippy from crates.io get redirected to the
2+
that folks trying to install Clippy from crates.io get redirected to the
33
`rustup` technique.
44

55
Before publishing, be sure to rename `clippy_dummy` to `clippy` in `Cargo.toml`,

clippy_dummy/crates-readme.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
Installing clippy via crates.io is deprecated. Please use the following:
1+
Installing Clippy via crates.io is deprecated. Please use the following:
22

33
```terminal
44
rustup component add clippy
55
```
66

7-
on a Rust version 1.29 or later. You may need to run `rustup self update` if it complains about a missing clippy binary.
7+
on a Rust version 1.29 or later. You may need to run `rustup self update` if it complains about a missing Clippy binary.
88

99
See [the homepage](https://github.com/rust-lang/rust-clippy/#clippy) for more information

lintcheck/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## `cargo lintcheck`
22

3-
Runs clippy on a fixed set of crates read from
3+
Runs Clippy on a fixed set of crates read from
44
`lintcheck/lintcheck_crates.toml` and saves logs of the lint warnings into the
55
repo. We can then check the diff and spot new or disappearing warnings.
66

@@ -84,7 +84,7 @@ This lets us spot bad suggestions or false positives automatically in some cases
8484

8585
> Note: Fix mode implies `--all-targets`, so it can fix as much code as it can.
8686
87-
Please note that the target dir should be cleaned afterwards since clippy will modify
87+
Please note that the target dir should be cleaned afterwards since Clippy will modify
8888
the downloaded sources which can lead to unexpected results when running lintcheck again afterwards.
8989

9090
### Recursive mode

0 commit comments

Comments
 (0)