rust-lang / rust-lang/rust-clippy
pedantic doc_markdown should suggest `[` `]` potentially as well as backticks
Open
Nobody has claimed this yet.
C-enhancement
- Dominant language
- Rust
- Stars
- 13.5k
- Forks
- 2.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 32
Description
If we're going pedantic,
doc_markdown should also suggest [ ] potentially around the backticks?
Do we stand half a chance of figuring out when that would be most appropriate? (If not we could suggest both options)
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
Start by locating the doc_markdown lint and reviewing how it currently suggests backticks. Determine whether the lint can identify when square brackets would be appropriate, or whether it should suggest both forms. Done means the suggestion behavior is defined and covered for the relevant cases.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100