Workaround property list indent #10364
Merged
Conversation
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
efba29b to
de97fb2
Compare
Merged
anntzer
approved these changes
Mar 3, 2018
|
Should this be backported somewhere? I'm not familiar neither with the backport policy nor with the mechanism. |
|
Oops, sorry, I should have milestoned it. |
|
@meeseeksdev backport to v2.2.x |
jklymak
added a commit
that referenced
this pull request
Mar 4, 2018
Backport PR #10364 on branch v2.2.x
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.
PR Summary
This is a simple workaround for an incorrect indentation of auto-generated property tables (#10161).
The current code had a fixed indent of 2. This PR simply increases it to 4. Of course, this is not the technically elegant solution, but it should do the trick.
Within parameter lists, the parameters are usually indented by 4 spaces. The two spaces resulted in a unexpected dedent of the table with respect to the parameter description (Docstring interpolation does not work correctly for indented insertions #10161). The 4 spaces will now result in a table on the same level as the text.
If the table was used in a regular paragraph, changing the indent from 2 to 4 should not have an effect for ReST either. (Not sure if this case happens at all.
This PR should do as a workaround to fix this for 2.2. Still, a proper indentation handling is desirable and should be pursued in the above issue.