Add new lint doc_overindented_list_items
#13711
Conversation
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @Centri3 (or someone else) some time within the next two weeks. Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (
|
rustbot
added
the
S-waiting-on-review
|
☔ The latest upstream changes (presumably 19426bf) made this pull request unmergeable. Please resolve the merge conflicts. |
tests/ui/doc/doc_lazy_list.fixed
Outdated
| /// }, | ||
| /// { | ||
| /// 'data': 0x0105 # to indicate 1.5 | ||
| /// } |
There was a problem hiding this comment.
It would be good to add error annotations here for consistency, like has already been done with it having no indentation.
tests/ui/doc/doc_lazy_list.stderr
Outdated
| | ^^^^^^^^^^^^^ | ||
| | | ||
| = help: if this is supposed to be its own paragraph, add a blank line | ||
| help: indent this line |
There was a problem hiding this comment.
copy+paste error? Over-indenting and under-indenting both say this.
There was a problem hiding this comment.
Ah, yes. I'll change them for over-indenting cases. Thanks.
Makes sense. I'll make a change. |
Align bullet points and improve indentation in the `Invariants` section
of the `GenDisk` struct documentation for better readability.
[ Yutaro is also working on implementing the lint we suggested to catch
this sort of issue in upstream Rust:
rust-lang/rust-clippy#13601
rust-lang/rust-clippy#13711
Thanks a lot! - Miguel ]
Fixes: 3253aba ("rust: block: introduce `kernel::block::mq` module")
Signed-off-by: Yutaro Ohno <[email protected]>
Reviewed-by: Boqun Feng <[email protected]>
Acked-by: Andreas Hindborg <[email protected]>
Link: https://lore.kernel.org/r/ZxkcU5yTFCagg_lX@ohnotp
Signed-off-by: Miguel Ojeda <[email protected]>
ohno418
force-pushed
the
doc-overindented-list-item
branch
2 times, most recently
from
b3cda74 to
d518346
Compare
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.
ohno418
force-pushed
the
doc-overindented-list-item
branch
from
d518346 to
f33f47d
Compare
ohno418
changed the title
doc_overindented_list_items
|
Just an initial comment: By "use the same code", I mean be in the same module :) Your original code is perfect in that regard, it just needs some refactoring to make it clear it's not just lazy continuation. Two lints can use the same code yet still emit different lints in both |
Add a new lint
doc_overindented_list_itemsto detect and fix list itemsin docs that are overindented.
For example,
this would be fixed to:
This lint improves readabiliy and consistency in doc.
.stderrfile)cargo testpasses locallycargo dev update_lintscargo dev fmtchangelog: [
doc_overindented_list_items]: Added a new lint that detects overindented list items in docsfixes: #13601