Skip to content

Commit 06d832d

Browse files
committed
docs(contributing): cite the dylint rules that enforce naming sections
`Generic Parameter Naming` and `Variable and Closure Parameter Naming` describe rules that `perfectionist` enforces in full. Add the same "enforced by `perfectionist::<rule>`" footnote that `Module Organization` and `Derive Macro Ordering` already carry. The textual guidance and worked examples stay; readers and AI agents now have the breadcrumb to the configured rule and its relevant `dylint.toml` knobs (`short_impl_max_lines`, `allowed_idents`, `extra_trivial_callback_methods`). https://claude.ai/code/session_01CoRidYHvni9nKNgxMPXmfQ
1 parent e87eca5 commit 06d832d

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,11 +88,11 @@ Use **descriptive names** for type parameters, not single letters:
8888

8989
- `Size`, `Name`, `SizeGetter`, `HardlinksRecorder`, `Report`
9090

91-
Single-letter generics are acceptable only in very short, self-contained trait impls.
91+
Single-letter generics are acceptable only in very short, self-contained trait impls. Enforced by `perfectionist::single_letter_generic`; the threshold for "very short" is the rule's `short_impl_max_lines` knob in `dylint.toml`.
9292

9393
### Variable and Closure Parameter Naming
9494

95-
Use **descriptive names** for variables and closure parameters by default. Single-letter names are permitted only in the specific cases listed below.
95+
Use **descriptive names** for variables and closure parameters by default. Single-letter names are permitted only in the specific cases listed below. Enforced by `perfectionist::single_letter_let_binding`, `perfectionist::single_letter_function_param`, and `perfectionist::single_letter_closure_param`; the per-rule `allowed_idents` and `extra_trivial_callback_methods` knobs in `dylint.toml` reflect the exceptions documented here.
9696

9797
#### When single-letter names are allowed
9898

0 commit comments

Comments
 (0)