Configurable non-English section titles for some documentation lints
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 55/100
Research direction
Start by reading the implementations and tests for clippy::missing_panics_doc, missing_safety_doc, and missing_errors_doc in the Clippy repository. Check how each lint recognizes section headings and how its tests cover them; the issue asks for configurable alternatives to Panics, Safety, and Errors. Done means configuration accepts localized headings and tests show those headings are recognized.
Written by the indexing model from the issue text.
Description
Description
The clippy::missing_panics_doc forces to use # Panics a the panic documentation section. Could it become configurable to also accept other words? (ex. # Paniques in French)
Same thing for # Safety and # Errors.
Version
Additional Labels
No response
- Dominant language
- Rust
- Stars
- 13.6k
- Forks
- 2.2k
- Avg merge
- 3d 11h
- Merged PRs (30d)
- 30
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from rust-lang/rust-clippy
-
A-documentation
Difficulty 1/5 Under an hour Newbie friendliness 91/100
rust-lang/rust-clippy#18023 ·
Maintainers usually reply within 1 day
-
C-bug D-confusing
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
rust-lang/rust-clippy#17976 · 2 comments ·
Maintainers usually reply within 1 day
-
C-bug L-suggestion
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
rust-lang/rust-clippy#17674 · 5 comments ·
Maintainers usually reply within 1 day
-
C-bug L-suggestion
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
rust-lang/rust-clippy#17673 · 3 comments ·
Maintainers usually reply within 1 day
-
`missing_const_for_thread_local` false positive on targets without `#[thread_local]`: fires on already-`const` initializersPossibly taken @LucaCappelletti94 claimed this 19 days ago. OpenC-bug I-false-positive
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
rust-lang/rust-clippy#17566 ·
Maintainers usually reply within 1 day
All issues in rust-lang/rust-clippy
Similar issues
-
good first issue help wanted program
Difficulty 2/5 1-3 hours Newbie friendliness 83/100
hffgzktbcc-blip/ounce-core#297 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
nautechsystems/nautilus_trader#5631 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 69/100
bytecodealliance/rustix#1736 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
longbridge/gpui-kit#3871 ·
Maintainers usually reply within 1 day
-
area:models enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day