rust-lang / rust-lang/rust-clippy
Should put `foo` between ticks fires for <code>
Open
Nobody has claimed this yet.
C-enhancement
E-medium
- Dominant language
- Rust
- Stars
- 13.5k
- Forks
- 2.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 32
Description
Steps to reproduce:
- Have an identifier
foo_bar - Have some HTML (e.g. a table) with
<code>foo_bar</code>or<code>foo_bar(<var>baz</var>)</code>
Actual results:
warning: you should put `foo_bar` between ticks in the documentation
Expected results:
Expected clippy to notice <code> and not suggest ticks for stuff that's already wrapped in <code>.
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 reproducing the warning with an identifier such as foo_bar documented inside <code> or <code>foo_bar(<var>baz</var>)</code>. Then locate the Clippy lint that suggests putting identifiers between ticks and inspect its existing tests, if present. Done means the lint no longer suggests ticks for identifiers already wrapped in <code> while preserving the warning for other documentation text.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100