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

zhongjiajie · 2020-07-06T09:10:09Z

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 · 2020-07-06T09:10:12Z

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept this contribution by verifying everyone involved has signed the PSF contributor agreement (CLA).

Recognized GitHub username

We couldn't find a bugs.python.org (b.p.o) account corresponding to the following GitHub usernames:

@zhongjiajie

This might be simply due to a missing "GitHub Name" entry in one's b.p.o account settings. This is necessary for legal reasons before we can look at this contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

You can check yourself to see if the CLA has been received.

Thanks again for the contribution, we look forward to reviewing it!

zhongjiajie · 2020-07-06T09:26:40Z

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 · 2020-07-06T13:01:19Z

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

zhongjiajie · 2020-07-06T13:42:52Z

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

tirkarthi · 2020-07-06T14:22:00Z

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.

Doc/faq/programming.rst

merwok

Thanks for working on this improvement!

Doc/faq/programming.rst

bedevere-bot · 2020-07-10T18:19:47Z

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.

Co-authored-by: Éric Araujo <merwok@netwok.org>

zhongjiajie · 2020-07-15T15:53:53Z

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.

merwok

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

zhongjiajie · 2020-08-05T16:34:00Z

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

tirkarthi

LGTM. Thanks.

zhongjiajie · 2020-08-08T07:45:37Z

So could we merge it to master?

merwok · 2020-08-08T16:13:14Z

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

serhiy-storchaka · 2020-08-08T17:43:28Z

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

miss-islington · 2020-08-08T19:29:07Z

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!

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 · 2020-08-08T19:29:18Z

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

bedevere-bot · 2020-08-08T19:29:25Z

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

merwok · 2020-08-08T19:29:30Z

Thanks for the PR!

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>

@merwok

…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

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.

Doc: Add output hint in faq programming

723fe5f

the-knights-who-say-ni added the CLA not signed label Jul 6, 2020

bedevere-bot added docs Documentation in the Doc dir awaiting review labels Jul 6, 2020

tirkarthi added skip issue skip news labels Jul 6, 2020

merwok reviewed Jul 6, 2020

View changes

Doc/faq/programming.rst Outdated Show resolved Hide resolved

merwok reviewed Jul 6, 2020

View changes

Doc/faq/programming.rst Outdated Show resolved Hide resolved

merwok reviewed Jul 6, 2020

View changes

Doc/faq/programming.rst Outdated Show resolved Hide resolved

the-knights-who-say-ni added CLA signed and removed CLA not signed labels Jul 7, 2020

Use console style and change class name

da3cbb6

merwok requested changes Jul 10, 2020

View changes

bedevere-bot removed the awaiting review label Jul 10, 2020

bedevere-bot added the awaiting changes label Jul 10, 2020

zhongjiajie and others added 4 commits Jul 15, 2020

Update Doc/faq/programming.rst

a7b67a9

Co-authored-by: Éric Araujo <merwok@netwok.org>

Update Doc/faq/programming.rst

66ea0ea

Co-authored-by: Éric Araujo <merwok@netwok.org>

Update Doc/faq/programming.rst

51480b7

Co-authored-by: Éric Araujo <merwok@netwok.org>

Update Doc/faq/programming.rst

99a9b4a

Co-authored-by: Éric Araujo <merwok@netwok.org>

Change ex4 class name and switch function name

5eec277

zhongjiajie force-pushed the doc-faq-programming branch from f71e07c to 5eec277 Compare Jul 15, 2020

zhongjiajie requested a review from merwok Jul 16, 2020

merwok changed the title ~~Doc: Add output hint to faq programming~~ Doc: Add output to example code in programming FAQ Jul 16, 2020

merwok added needs backport to 3.8 needs backport to 3.9 labels Jul 16, 2020

merwok approved these changes Jul 16, 2020

View changes

bedevere-bot added awaiting merge and removed awaiting changes labels Jul 16, 2020

tirkarthi approved these changes Aug 6, 2020

View changes

tirkarthi closed this Aug 6, 2020

tirkarthi reopened this Aug 6, 2020

merwok added the 🤖 automerge PR will be merged once it's been approved and all CI passed label Aug 8, 2020

miss-islington merged commit 67acf74 into python:master Aug 8, 2020
4 checks passed

bedevere-bot removed the awaiting merge label Aug 8, 2020

bedevere-bot removed the needs backport to 3.9 label Aug 8, 2020

bedevere-bot removed the needs backport to 3.8 label Aug 8, 2020

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

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

zhongjiajie commented Jul 6, 2020 •

edited by miss-islington

the-knights-who-say-ni commented Jul 6, 2020

zhongjiajie commented Jul 6, 2020 •

edited

tirkarthi commented Jul 6, 2020

zhongjiajie commented Jul 6, 2020

tirkarthi commented Jul 6, 2020

merwok left a comment

bedevere-bot commented Jul 10, 2020

zhongjiajie commented Jul 15, 2020 •

edited

merwok left a comment

zhongjiajie commented Aug 5, 2020

tirkarthi left a comment

zhongjiajie commented Aug 8, 2020

merwok commented Aug 8, 2020

serhiy-storchaka commented Aug 8, 2020

miss-islington commented Aug 8, 2020

bedevere-bot commented Aug 8, 2020

bedevere-bot commented Aug 8, 2020

merwok commented Aug 8, 2020

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

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

Conversation

zhongjiajie commented Jul 6, 2020 • edited by miss-islington

the-knights-who-say-ni commented Jul 6, 2020

Recognized GitHub username

zhongjiajie commented Jul 6, 2020 • edited

tirkarthi commented Jul 6, 2020

zhongjiajie commented Jul 6, 2020

tirkarthi commented Jul 6, 2020

merwok left a comment

bedevere-bot commented Jul 10, 2020

zhongjiajie commented Jul 15, 2020 • edited

merwok left a comment

zhongjiajie commented Aug 5, 2020

tirkarthi left a comment

zhongjiajie commented Aug 8, 2020

merwok commented Aug 8, 2020

serhiy-storchaka commented Aug 8, 2020

miss-islington commented Aug 8, 2020

bedevere-bot commented Aug 8, 2020

bedevere-bot commented Aug 8, 2020

merwok commented Aug 8, 2020

zhongjiajie commented Jul 6, 2020 •

edited by miss-islington

zhongjiajie commented Jul 6, 2020 •

edited

zhongjiajie commented Jul 15, 2020 •

edited