rust-lang / rust-lang/rust-clippy
`tabs_in_doc_comments` suggests me to use spaces for indentation
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 13.5k
- Forks
- 2.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 32
Description
Lint name: tabs_in_doc_comments
I tried this code:
/**
* Some code documentation
* string.
*/
I expected to see this happen: The lint only activates when using tabs within the comment block, and not to indent the block.
Instead, this happened: I get a lint suggesting to replace my tabs with spaces. Doing this would result in mixed indentation (I generally use tabs and the lines with the comment would use spaces instead), which is bad.
Meta
cargo clippy -V:clippy 0.1.51 (2fd73fa 2021-03-23)rustc -Vv:rustc 1.51.0 (2fd73fabe 2021-03-23) binary: rustc commit-hash: 2fd73fabe469357a12c2c974c140f67e7cdd76d0 commit-date: 2021-03-23 host: x86_64-unknown-linux-gnu release: 1.51.0 LLVM version: 11.0.1
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 implementation and tests for the tabs_in_doc_comments lint, then reproduce the report with the Rust example in the issue. Done means indentation tabs for the comment block are not flagged, while tabs within the comment remain subject to the lint.
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