[doc] Fix dis markup by andresdelfino · Pull Request #23524 · python/cpython · GitHub
Skip to content

[doc] Fix dis markup - #23524

Merged
gpshead merged 1 commit into
python:masterfrom
andresdelfino:dis_markup
Nov 28, 2020
Merged

[doc] Fix dis markup#23524
gpshead merged 1 commit into
python:masterfrom
andresdelfino:dis_markup

Conversation

@andresdelfino

@andresdelfino andresdelfino commented Nov 26, 2020

Copy link
Copy Markdown
Contributor

No description provided.

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Nov 26, 2020
@gpshead
gpshead merged commit fa840cc into python:master Nov 28, 2020
@miss-islington

miss-islington commented Nov 28, 2020

Copy link
Copy Markdown
Contributor

@gpshead

gpshead commented Nov 28, 2020

Copy link
Copy Markdown
Member

thanks!

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 28, 2020
@andresdelfino @miss-islington
Fix dis markup (pythonGH-23524)
4b482f4 
(cherry picked from commit fa840cc)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
@bedevere-bot

bedevere-bot commented Nov 28, 2020

Copy link
Copy Markdown

GH-23545 is a backport of this pull request to the 3.9 branch.

miss-islington added a commit that referenced this pull request Nov 28, 2020
@miss-islington @andresdelfino
Fix dis markup (GH-23524)
cfb2f79 
(cherry picked from commit fa840cc)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
@andresdelfino
andresdelfino deleted the dis_markup branch November 28, 2020 22:27
@rhettinger

rhettinger commented Nov 29, 2020

Copy link
Copy Markdown
Contributor

Does this have any visual effect for the reader?

@serhiy-storchaka

serhiy-storchaka commented Nov 29, 2020

Copy link
Copy Markdown
Member

Good catch! And it is common error. Perhaps we can add a check in Doc/tools/rstlint.py which checks that the text following a directive does not have excessive indentation.

@mdickinson

mdickinson commented Nov 29, 2020

Copy link
Copy Markdown
Member

which checks that the text following a directive does not have excessive indentation

I think the issue wasn't excessive indentation, but instead inconsistent indentation within the block for the directive. The text was indented four spaces while the .. versionadded directive that was also part of the same block was indented three spaces. Indenting the .. versionadded directive one extra space would also have fixed the issue.

@andresdelfino

andresdelfino commented Nov 29, 2020

Copy link
Copy Markdown
Contributor Author

adorilson pushed a commit to adorilson/cpython that referenced this pull request Mar 13, 2021
@andresdelfino @adorilson
Fix dis markup (pythonGH-23524)
1861071
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@gpshead gpshead gpshead approved these changes
@Fidget-Spinner Fidget-Spinner Fidget-Spinner approved these changes

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip issue skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

9 participants

@andresdelfino @miss-islington @gpshead @bedevere-bot @rhettinger @serhiy-storchaka @mdickinson @Fidget-Spinner @the-knights-who-say-ni