-
-
Notifications
You must be signed in to change notification settings - Fork 33.3k
Improving readability of argparse.rst #91751
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
Conversation
Fixed few typos and enhanced few paragraphs
|
Every change to Python requires a NEWS entry. Please, add it using the blurb_it Web app or the blurb command-line tool. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
| $ python prog.py 1 2 3 4 --sum | ||
| 10 | ||
| If invalid arguments are passed in, it will issue an error: |
There was a problem hiding this comment.
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: |
There was a problem hiding this comment.
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.
Doc/library/argparse.rst
Outdated
| module. Moreover, it automatically generates the "help and usage messages" and | ||
| "issues errors" when users provide invalid arguments to the program. |
There was a problem hiding this comment.
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.
|
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 |
Improve wording.
|
@xandrade: Status check is done, and it's a success ✅ . |
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