Add lint for overindented list items in docs #13711
Conversation
Add a lint 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.
|
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. |
| /// }, | ||
| /// { | ||
| /// '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.
| | ^^^^^^^^^^^^^ | ||
| | | ||
| = 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.
Makes sense. I'll make a change. |
Add a lint to detect and fix list items in docs that are overindented.
For example,
this would be fixed to:
This lint improves readabiliy and consistency in doc.
changelog: [
doc_lazy_continuation]: Added a lint to detect list items that are overindentedfixes: #13601