rust-lang / rust-lang/rust-clippy
doc_markdown should ignore things which just contain acronyms
Open
Nobody has claimed this yet.
C-enhancement
good first issue
- Dominant language
- Rust
- Stars
- 13.5k
- Forks
- 2.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 32
Description
Instead of needing to manually whitelist, we should ignore things like DirectX and OpenGL. For something to be camel case, it should have at least two camelcase words in it, each which have at least one lowercase letter.
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
Locate the doc_markdown lint and its existing tests, then read how camel-case terms and whitelist exceptions are identified. Add coverage for acronym-only names such as DirectX and OpenGL, while preserving detection of names containing at least two camelcase words with lowercase letters; done means the new cases are ignored without manual whitelisting.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100