Reformat some docs to work around clippy::doc_overindented_list_items
#811
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is a new lint in nightly.
DJMcNab
reviewed
Feb 6, 2025
| @@ -460,18 +461,18 @@ impl<'a> PathEncoder<'a> { | |||
| /// The algorithm is as follows: | |||
| /// | |||
| /// a) If a GPU thread is processing a regular segment (i.e. `SUBPATH_END_BIT` is 0), it | |||
| /// outputs the offset curves for the segment. If the segment is immediately followed by | |||
There was a problem hiding this comment.
I think that making this a proper nested sublist is probably better style, i.e. replace a) with either 1. or -.
Certainly the existing indentation strongly suggests it's intended to be a nested sublist
| @@ -14,18 +14,19 @@ pub struct Style { | |||
| /// Encodes the stroke and fill style parameters. This field is split into two 16-bit | |||
| /// parts: | |||
| /// | |||
| /// - `flags: u16` - encodes fill vs stroke, even-odd vs non-zero fill mode for fills and cap | |||
There was a problem hiding this comment.
I don't have strong feelings about this one, although I'm not sure that the new formatting is better. I can see reasonable arguments for making it an HTML table, or just expecting the lint here.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a new lint in nightly.