X Tutup
The Wayback Machine - https://web.archive.org/web/20221223105602/https://github.com/python/cpython/pull/91751
Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improving readability of argparse.rst #91751

Merged
merged 2 commits into from Apr 30, 2022
Merged

Conversation

xandrade
Copy link
Contributor

@xandrade xandrade commented Apr 20, 2022

Fixed few typos and enhanced few paragraphs for your review and consideration.
Trivial contribution towards continuous improvement, so no issue was raised.

Automerge-Triggered-By: GH:rhettinger

Fixed few typos and enhanced few paragraphs
@bedevere-bot
Copy link

bedevere-bot commented Apr 20, 2022

Every change to Python requires a NEWS entry.

Please, add it using the blurb_it Web app or the blurb command-line tool.

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Apr 20, 2022
Copy link
Sponsor Member

@Mariatta Mariatta left a comment

Some of the changes here make sense, but the rest, I don't think the change adds any more value, so I'd like to keep them.

I've identified the ones which I'd like you to revert.

@@ -119,7 +119,7 @@ the command-line integers:
$ python prog.py 1 2 3 4 --sum
10

If invalid arguments are passed in, it will issue an error:
Copy link
Sponsor Member

@Mariatta Mariatta Apr 20, 2022

Choose a reason for hiding this comment

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

I would keep this unchanged.

Assuming the Python code above is saved into a file called ``prog.py``, it can
be run at the command line and provides useful help messages:
Copy link
Sponsor Member

@Mariatta Mariatta Apr 20, 2022

Choose a reason for hiding this comment

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

I would keep the original text on both lines here.

module. Moreover, it automatically generates the "help and usage messages" and
"issues errors" when users provide invalid arguments to the program.
Copy link
Sponsor Member

@Mariatta Mariatta Apr 20, 2022

Choose a reason for hiding this comment

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

Please keep the original text on this pargraph.

@bedevere-bot
Copy link

bedevere-bot commented Apr 20, 2022

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.

Improve wording.
@rhettinger rhettinger added the 🤖 automerge PR will be merged once it's been approved and all CI passed label Apr 30, 2022
@miss-islington
Copy link
Contributor

miss-islington commented Apr 30, 2022

@xandrade: Status check is done, and it's a success .

@miss-islington miss-islington merged commit 238aa62 into python:main Apr 30, 2022
13 checks passed
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 🤖 automerge PR will be merged once it's been approved and all CI passed skip issue skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants
X Tutup