about summary refs log tree commit diff
path: root/compiler/rustc_codegen_llvm/src
diff options
context:
space:
mode:
authorCatherine Flores <catherine.3.flores@gmail.com>2025-01-28 08:50:48 +0000
committerGitHub <noreply@github.com>2025-01-28 08:50:48 +0000
commit80c2d098516fc500ad1f1a57c762fa6f224064f1 (patch)
tree5e0ff5fa639c5f416904b0598a894c7368c08471 /compiler/rustc_codegen_llvm/src
parent66dc8a1a30b19f31454a9e58f8723500a1a8ad17 (diff)
parent4693d0a9ffceeabed36d2e82be3cfce5e1322b30 (diff)
downloadrust-80c2d098516fc500ad1f1a57c762fa6f224064f1.tar.gz
rust-80c2d098516fc500ad1f1a57c762fa6f224064f1.zip
Add new lint `doc_overindented_list_items` (#13711)
Add a new lint `doc_overindented_list_items` to detect and fix list
items
in docs that are overindented.

For example,

```rs
/// - first line
///      second line
fn foo() {}
```

this would be fixed to:

```rs
/// - first line
///   second line
fn foo() {}
```

This lint improves readabiliy and consistency in doc.

---

- \[x] Followed [lint naming conventions][lint_naming]
- \[x] Added passing UI tests (including committed `.stderr` file)
- \[x] `cargo test` passes locally
- \[x] Executed `cargo dev update_lints`
- \[x] Added lint documentation
- \[x] Run `cargo dev fmt`

[lint_naming]:
https://rust-lang.github.io/rfcs/0344-conventions-galore.html#lints

changelog: [`doc_overindented_list_items`]: Added a new lint that
detects overindented list items in docs
fixes: #13601
Diffstat (limited to 'compiler/rustc_codegen_llvm/src')
0 files changed, 0 insertions, 0 deletions