mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Try to clear up confusion between type and category.

Browse Source
This commit is contained in:
blyxyas 2023-04-10 21:42:00 +02:00 committed by Philipp Krones
parent c22906b37f
commit 735380b2cc
No known key found for this signature in database
GPG Key ID: 1CA0DF2AF59D68A5
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
book/src/development/defining_lints.md
View File

@ -41,7 +41,6 @@ There are two things to note here:
is an `early` lint pass. We will discuss this difference in a later chapter. is an `early` lint pass. We will discuss this difference in a later chapter.
<!-- FIXME: Link that "later chapter" when lint_passes.md is merged --> <!-- FIXME: Link that "later chapter" when lint_passes.md is merged -->
2. If not provided, the `category` of this new lint will default to `nursery`. 2. If not provided, the `category` of this new lint will default to `nursery`.
See Clippy's [lint types](../lints.md) for more information on categories.
The `cargo dev new_lint` command will create a new file: `clippy_lints/src/foo_functions.rs` The `cargo dev new_lint` command will create a new file: `clippy_lints/src/foo_functions.rs`
as well as [register the lint](#lint-registration). as well as [register the lint](#lint-registration).
@ -67,6 +66,8 @@ Untracked files:
### Specific Type ### Specific Type
> **Note**: Lint types are listed in the ["Lint types"](#lint-types) section
If you believe that this new lint belongs to a specific type of lints, If you believe that this new lint belongs to a specific type of lints,
you can run `cargo dev new_lint` with a `--type` option. you can run `cargo dev new_lint` with a `--type` option.
@ -135,7 +136,7 @@ the lint pass in question will not be run.
## Lint types ## Lint types
As of the writing of this documentation update, there are 12 categories (a.k.a. _types_) As of the writing of this documentation update, there are 12 groups (a.k.a. _types_)
of lints besides the numerous standalone lints living under `clippy_lints/src/`: of lints besides the numerous standalone lints living under `clippy_lints/src/`:
- `cargo` - `cargo`