Increase indent in definition lists#4296
Merged
greg0ire merged 1 commit intodoctrine:2.11.xfrom Sep 26, 2020
Merged
Conversation
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
morozov
approved these changes
Sep 25, 2020
Member
morozov
left a comment
There was a problem hiding this comment.
The existing markup looks valid according to the reference. There are other structures that use 4 spaces instead of two, so I have no idea of the potential side effects of using 4 spaces where the standard expects two are.
I'll approve if you want to proceed.
SenseException
approved these changes
Sep 26, 2020
Member
SenseException
left a comment
There was a problem hiding this comment.
I have no idea of the potential side effects of using 4 spaces where the standard expects two are.
Neither do I. There's a project with dozens of pages in rst and the indent of 4 had no negative impact.
Member
Author
|
Ok let's proceed then. |
rgrellmann
pushed a commit
to Rossmann-IT/dbal
that referenced
this pull request
Mar 7, 2021
Release [2.11.1](https://github.com/doctrine/dbal/milestone/80) 2.11.1 ====== - Total issues resolved: **2** - Total pull requests resolved: **8** - Total contributors: **6** Documentation ------------- - [4299: Link to contributing guide](doctrine#4299) thanks to @greg0ire SQLite,Test Suite,pdo_sqlite ---------------------------- - [4297: Fix ExceptionTest::testConnectionExceptionSqLite() on macOS](doctrine#4297) thanks to @morozov - [4296: Increase indent in definition lists](doctrine#4296) thanks to @greg0ire Deprecation,Prepared Statements ------------------------------- - [4291: Deprecate Abstraction\Result](doctrine#4291) thanks to @morozov BC Fix,Quoting -------------- - [4287: Restore PDOStatement::quote() for backward compatibility](doctrine#4287) thanks to @morozov and @Shahelm BC Fix,Query ------------ - [4286: Fix BC break: QueryBuilder::andWhere() etc. should ignore empty strings](doctrine#4286) thanks to @BenMorel and @infabo Bug,Documentation,Prepared Statements ------------------------------------- - [4285: Fix phpdoc on deprecated functions](doctrine#4285) thanks to @qdequippe Bug,PDO,Prepared Statements --------------------------- - [4173: Fix Third parameter not allowed for PDO::FETCH&doctrine#95;COLUMN](doctrine#4173) thanks to @BenMorel # gpg: Signature made Sun Sep 27 06:35:40 2020 # gpg: using DSA key 1BEDEE0A820BC30D858F9F0C2C3A645671828132 # gpg: Can't check signature: No public key
This file contains hidden or 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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
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-parserinstead, or if you think we are just dealing with what could be called Doctrine-flavored RST here.