Increase indent in definition lists #4296
Merged
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.
Although the official docs [1] show examples of definition list with an
indent of 2 spaces, it seems that doctrine/rst-parser has been written
with an indent of 4 spaces in mind. [2]
This should ensure the definition lists are properly parsed as such,
right now they are parsed as paragraphs.
[1] https://docutils.sourceforge.io/docs/user/rst/quickref.html#definition-lists
[2] https://github.com/doctrine/rst-parser/blob/d97da75a8a2cab33453711f01b90303f5c3845db/lib/Parser/LineDataParser.php#L154
Please tell me if you think I should report this as a bug to
doctrine/rst-parser
instead, or if you think we are just dealing with what could be called Doctrine-flavored RST here.