Corrected formatting of multi-line code block by madphysicist · Pull Request #13806 · python/cpython · GitHub
Skip to content

Corrected formatting of multi-line code block - #13806

Merged
taleinat merged 1 commit into
python:masterfrom
madphysicist:patch-1
Jul 17, 2019
Merged

Corrected formatting of multi-line code block#13806
taleinat merged 1 commit into
python:masterfrom
madphysicist:patch-1

Conversation

@madphysicist

@madphysicist madphysicist commented Jun 4, 2019

Copy link
Copy Markdown
Contributor

Trivial change. Replaced `` around block with :: before it.

@the-knights-who-say-ni

the-knights-who-say-ni commented Jun 4, 2019

Copy link
Copy Markdown

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Jun 4, 2019
tirkarthi
tirkarthi approved these changes Jun 4, 2019
View reviewed changes

@tirkarthi tirkarthi left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This improves over the current formatting which makes 2 lines appear as a single line at https://docs.python.org/3/c-api/buffer.html#numpy-style-shape-and-strides. With PR

Screen Shot 2019-06-04 at 11 52 12 pm

Thanks.

@madphysicist

madphysicist commented Jun 4, 2019

Copy link
Copy Markdown
Contributor Author

@tirkarthi You're welcome. Should I do anything about the missing semicolon at the end of the first line?

@tirkarthi

tirkarthi commented Jun 5, 2019

Copy link
Copy Markdown
Member

I guess for the short snippet semicolon is implicit. I don't have a strong opinion about it. Maybe you can add it if the core dev who will be merging it makes the suggestion.

@taleinat

taleinat commented Jun 27, 2019

Copy link
Copy Markdown
Contributor

Since this is C code, there should likely be a semicolon at the end of that line. Certainly in a code example in the docs, there should be a semicolon at the end of a simple statement. Please do add it while we're here!

@madphysicist

madphysicist commented Jul 6, 2019

Copy link
Copy Markdown
Contributor Author

@taleinat Done. Sorry it took so long. I usually take less than 8 days to type one character :)

taleinat
taleinat reviewed Jul 9, 2019
View reviewed changes

@taleinat taleinat left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ISTM we should use .. code-block:: c for this code block, so that it is properly marked up as C code.

@madphysicist

madphysicist commented Jul 17, 2019

Copy link
Copy Markdown
Contributor Author

@taleinat I added the code-block directive. I believe that should be it for this trivial change. The PR seems to need a "skip issue" and "skip news" label, but I am not familiar enough with the CPython process to be sure.

@taleinat

taleinat commented Jul 17, 2019

Copy link
Copy Markdown
Contributor

@taleinat I added the code-block directive. I believe that should be it for this trivial change. The PR seems to need a "skip issue" and "skip news" label, but I am not familiar enough with the CPython process to be sure.

Indeed!

taleinat
taleinat approved these changes Jul 17, 2019
View reviewed changes

@taleinat taleinat left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@taleinat
taleinat merged commit bd26a44 into python:master Jul 17, 2019
@miss-islington

miss-islington commented Jul 17, 2019

Copy link
Copy Markdown
Contributor

Thanks @madphysicist for the PR, and @taleinat for merging it 🌮🎉.. I'm working now to backport this PR to: 3.7, 3.8.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 17, 2019
@madphysicist @miss-islington
Docs: Correct formatting of a multiline code block (pythonGH-13806)
d82dc8b 
(cherry picked from commit bd26a44)

Co-authored-by: Joseph Fox-Rabinovitz <madphysicist@users.noreply.github.com>
@bedevere-bot

bedevere-bot commented Jul 17, 2019

Copy link
Copy Markdown

GH-14805 is a backport of this pull request to the 3.8 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 17, 2019
@madphysicist @miss-islington
Docs: Correct formatting of a multiline code block (pythonGH-13806)
1bede66 
(cherry picked from commit bd26a44)

Co-authored-by: Joseph Fox-Rabinovitz <madphysicist@users.noreply.github.com>
@bedevere-bot

bedevere-bot commented Jul 17, 2019

Copy link
Copy Markdown

GH-14806 is a backport of this pull request to the 3.7 branch.

miss-islington added a commit that referenced this pull request Jul 17, 2019
@miss-islington @madphysicist
Docs: Correct formatting of a multiline code block (GH-13806)
35d36da 
(cherry picked from commit bd26a44)

Co-authored-by: Joseph Fox-Rabinovitz <madphysicist@users.noreply.github.com>
miss-islington added a commit that referenced this pull request Jul 17, 2019
@miss-islington @madphysicist
Docs: Correct formatting of a multiline code block (GH-13806)
ba3c89f 
(cherry picked from commit bd26a44)

Co-authored-by: Joseph Fox-Rabinovitz <madphysicist@users.noreply.github.com>
@taleinat

taleinat commented Jul 17, 2019

Copy link
Copy Markdown
Contributor

Thanks for contributing this fix, @madphysicist!

@madphysicist

madphysicist commented Jul 17, 2019

Copy link
Copy Markdown
Contributor Author

@madphysicist
madphysicist deleted the patch-1 branch July 17, 2019 11:35
lisroach pushed a commit to lisroach/cpython that referenced this pull request Sep 10, 2019
@madphysicist @lisroach
Docs: Correct formatting of a multiline code block (pythonGH-13806)
d808648
DinoV pushed a commit to DinoV/cpython that referenced this pull request Jan 14, 2020
@madphysicist @DinoV
Docs: Correct formatting of a multiline code block (pythonGH-13806)
63c7d9e
websurfer5 pushed a commit to websurfer5/cpython that referenced this pull request Jul 20, 2020
@madphysicist @websurfer5
Docs: Correct formatting of a multiline code block (pythonGH-13806)
f183092
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@taleinat taleinat taleinat approved these changes
@tirkarthi tirkarthi tirkarthi approved these changes
+1 more reviewer
@Carreau Carreau Carreau approved these changes
Reviewers whose approvals may not affect merge requirements

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.

7 participants

@madphysicist @the-knights-who-say-ni @tirkarthi @taleinat @miss-islington @bedevere-bot @Carreau