Doc: Add output to example code in programming FAQ by zhongjiajie · Pull Request #21346 · python/cpython · GitHub
Skip to content

Doc: Add output to example code in programming FAQ#21346

Merged
miss-islington merged 7 commits into
python:masterfrom
zhongjiajie:doc-faq-programming
Aug 8, 2020
Merged

Doc: Add output to example code in programming FAQ#21346
miss-islington merged 7 commits into
python:masterfrom
zhongjiajie:doc-faq-programming

Conversation

@zhongjiajie

@zhongjiajie zhongjiajie commented Jul 6, 2020

Copy link
Copy Markdown
Contributor

Add output hint to document, part faq/programming, section How do I write a function with output parameters (call by reference)?.

This patch make the output hint just like prefix code block.

Automerge-Triggered-By: @merwok

@the-knights-who-say-ni

Copy link
Copy Markdown

@zhongjiajie

zhongjiajie commented Jul 6, 2020

Copy link
Copy Markdown
Contributor Author

I create new account in b.p.o, and singed CLA just now.
Just a doc/comment change, I don't know should I create new issue in b.p.o or not. If should create a new one, let me know, thx

@tirkarthi

Copy link
Copy Markdown
Member

I have added skip-issue and skip-news labels since minor changes don't need issue and news entry.

@zhongjiajie

Copy link
Copy Markdown
Contributor Author

@tirkarthi Thanks. Does it mean this PR could be merged after CLA pass/effective?

@tirkarthi

Copy link
Copy Markdown
Member

It would still require an approval from a core developer to get merged. I added the labels so that the PR is green with all checks passing.

Comment thread Doc/faq/programming.rst Outdated
Comment thread Doc/faq/programming.rst Outdated
Comment thread Doc/faq/programming.rst Outdated

@merwok merwok 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.

Thanks for working on this improvement!

Comment thread Doc/faq/programming.rst Outdated
Comment thread Doc/faq/programming.rst Outdated
Comment thread Doc/faq/programming.rst Outdated
Comment thread Doc/faq/programming.rst Outdated
Comment thread Doc/faq/programming.rst Outdated
Comment thread Doc/faq/programming.rst Outdated
@bedevere-bot

Copy link
Copy Markdown

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

zhongjiajie and others added 4 commits July 15, 2020 23:34
Co-authored-by: Éric Araujo <merwok@netwok.org>
Co-authored-by: Éric Araujo <merwok@netwok.org>
Co-authored-by: Éric Araujo <merwok@netwok.org>
Co-authored-by: Éric Araujo <merwok@netwok.org>
@zhongjiajie

zhongjiajie commented Jul 15, 2020

Copy link
Copy Markdown
Contributor Author

It's odd, there is a new commit in my branch zhongjiajie@5eec277 but not including in this PR, I don't know what going on.

@zhongjiajie zhongjiajie force-pushed the doc-faq-programming branch from f71e07c to 5eec277 Compare July 15, 2020 16:46
@zhongjiajie zhongjiajie requested a review from merwok July 16, 2020 14:33
@merwok merwok changed the title Doc: Add output hint to faq programming Doc: Add output to example code in programming FAQ Jul 16, 2020

@merwok merwok 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.

Looks good! I’d just like a second review.

@zhongjiajie

Copy link
Copy Markdown
Contributor Author

@tirkarthi Could you please take a look at this patch? we need one more approval here

@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.

LGTM. Thanks.

@tirkarthi tirkarthi closed this Aug 6, 2020
@tirkarthi tirkarthi reopened this Aug 6, 2020
@zhongjiajie

Copy link
Copy Markdown
Contributor Author

So could we merge it to master?

@merwok

merwok commented Aug 8, 2020

Copy link
Copy Markdown
Member

I’m just not clear about backport rules given that 3.9 is in beta

@serhiy-storchaka

Copy link
Copy Markdown
Member

Documentation changes can be backported to any maintained version. Feature freeze does not affect this.

@miss-islington miss-islington merged commit 67acf74 into python:master Aug 8, 2020
@miss-islington

Copy link
Copy Markdown
Contributor

Thanks @zhongjiajie for the PR 🌮🎉.. I'm working now to backport this PR to: 3.8, 3.9.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 8, 2020
Add output hint to document, part faq/programming, section [How do I write a function with output parameters (call by reference)?](https://docs.python.org/3/faq/programming.htmlGH-how-do-i-write-a-function-with-output-parameters-call-by-reference).

This patch make the output hint just like prefix code block.
(cherry picked from commit 67acf74)

Co-authored-by: Jiajie Zhong <zhongjiajie955@hotmail.com>
@bedevere-bot

Copy link
Copy Markdown

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

@bedevere-bot

Copy link
Copy Markdown

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

@merwok

merwok commented Aug 8, 2020

Copy link
Copy Markdown
Member

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 8, 2020
Add output hint to document, part faq/programming, section [How do I write a function with output parameters (call by reference)?](https://docs.python.org/3/faq/programming.htmlGH-how-do-i-write-a-function-with-output-parameters-call-by-reference).

This patch make the output hint just like prefix code block.
(cherry picked from commit 67acf74)

Co-authored-by: Jiajie Zhong <zhongjiajie955@hotmail.com>
miss-islington added a commit that referenced this pull request Aug 9, 2020
Add output hint to document, part faq/programming, section [How do I write a function with output parameters (call by reference)?](https://docs.python.org/3/faq/programming.htmlGH-how-do-i-write-a-function-with-output-parameters-call-by-reference).

This patch make the output hint just like prefix code block.
(cherry picked from commit 67acf74)

Co-authored-by: Jiajie Zhong <zhongjiajie955@hotmail.com>
miss-islington added a commit that referenced this pull request Aug 9, 2020
…H-21791)

Add output hint to document, part faq/programming, section [How do I write a function with output parameters (call by reference)?](https://docs.python.org/3/faq/programming.htmlGH-how-do-i-write-a-function-with-output-parameters-call-by-reference).

This patch make the output hint just like prefix code block.
(cherry picked from commit 67acf74)


Co-authored-by: Jiajie Zhong <zhongjiajie955@hotmail.com>

Automerge-Triggered-By: @merwok
shihai1991 pushed a commit to shihai1991/cpython that referenced this pull request Aug 20, 2020
Add output hint to document, part faq/programming, section [How do I write a function with output parameters (call by reference)?](https://docs.python.org/3/faq/programming.html#how-do-i-write-a-function-with-output-parameters-call-by-reference).

This patch make the output hint just like prefix code block.
xzy3 pushed a commit to xzy3/cpython that referenced this pull request Oct 18, 2020
Add output hint to document, part faq/programming, section [How do I write a function with output parameters (call by reference)?](https://docs.python.org/3/faq/programming.html#how-do-i-write-a-function-with-output-parameters-call-by-reference).

This patch make the output hint just like prefix code block.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation in the Doc dir skip issue skip news

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants