rust-lang / rust-lang/rust-clippy
New lint: Puncuate end of sentences.
Open
Nobody has claimed this yet.
A-lint
- Dominant language
- Rust
- Stars
- 13.5k
- Forks
- 2.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 32
Description
What it does
This lint suggests to end a sentence with punctuation if there is a newline gap, (two \n\n) or the doc comment ends.
Lint Name
puncuate_end_sentence
Category
pedantic
Advantage
- Documentation is made clearer with punctuation at the end of short sentences and long paragraphs.
Drawbacks
- This lint only works for the end of documentation or where a new line gap is present. Otherwise we would have to embed a grammar engine into clippy.
- This lint is not easily applicable in languages that are not descended from Latin (hence the pedantic category).
Example
/// Returns the meaning of life
fn meaning_of_life() -> u32 {
42
}
Could be written as:
/// Returns the meaning of life.
fn meaning_of_life() -> u32 {
42
}
Contributor 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.
Research direction
No files, tests, or entry points are named in the issue. Before starting, identify where a new Clippy lint and its tests belong; done means the proposed lint detects sentence endings as described and has coverage for the stated documentation-comment cases.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- devtools
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100