Skip to content

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

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
Member

@Mariatta Mariatta left a 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:
Copy link
Member

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.

Comment on lines -94 to -95
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
Member

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.

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

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

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.
@miss-islington
Copy link
Contributor

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

@miss-islington miss-islington merged commit 238aa62 into python:main Apr 30, 2022
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.

5 participants