Skip to content

gh-90437: Fix __main__.py documentation wording #30480

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

gh-90437: Fix __main__.py documentation wording #30480

wants to merge 8 commits into from
+3 −3

Conversation

riqts
Copy link

@riqts riqts commented Jan 8, 2022 •
edited by merwok
Loading

@bedevere-bot bedevere-bot added the docs Documentation in the Doc dir label Jan 8, 2022
@the-knights-who-say-ni
Copy link

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

CLA Missing

Our records indicate the following people have not signed the CLA:

@riqts

For legal reasons we need all the people listed to sign the CLA before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

If you have recently signed the CLA, please wait at least one business day
before our records are updated.

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

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

@riqts riqts changed the title 46279: Fixed __main__.py documentation typo bpo-46279: Fixed __main__.py documentation typo Jan 8, 2022
@taleinat
Copy link
Contributor

taleinat commented Jan 8, 2022

Something the NEWS check doesn't know is that we don't add NEWS entries for documentation-only fixes. I've added the appropriate label to this PR. Please remove the NEWS entry, and sorry for the confusion!

@taleinat
Copy link
Contributor

taleinat commented Jan 8, 2022

Thanks for this PR!

Reviewers, please note that the discussion on the b.p.o. issue is still ongoing, and this approach doesn't seem to be the leading one.

taleinat
taleinat requested changes Jan 9, 2022
View reviewed changes
Copy link
Contributor

@taleinat taleinat left a comment

Choose a reason for hiding this comment

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

Formatting needs fixing, but otherwise looks good to me.

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

@riqts @taleinat
Update Doc/library/__main__.rst
c30b653 
Co-authored-by: Tal Einat <532281+taleinat@users.noreply.github.com>
@riqts
Copy link
Author

riqts commented Jan 10, 2022

I have made the requested changes; please review again

@bedevere-bot
Copy link

Thanks for making the requested changes!

@taleinat: please review the changes made to this pull request.

@bedevere-bot bedevere-bot requested a review from taleinat January 10, 2022 07:53
@github-actions
Copy link

This PR is stale because it has been open for 30 days with no activity.

@github-actions github-actions bot added the stale Stale PR or inactive for long period of time. label Feb 10, 2022
ferdnyc
ferdnyc reviewed Mar 19, 2022
View reviewed changes
rhettinger
rhettinger requested changes May 10, 2022
View reviewed changes
@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.

@ferdnyc ferdnyc mannequin mentioned this pull request Aug 26, 2022
Closed
@merwok
Copy link
Member

merwok commented Aug 26, 2022

Please also update the PR title to match the ticket, and reference gh-nnnn instead of bpo-nnnn 🙂

@ferdnyc
Copy link
Contributor

ferdnyc commented Aug 26, 2022

That would make the title this:

gh-90437: Minor information-ordering issue in __main__ doc

If @riqts is still playing along at home.

(Not that I think my issue title is so great; I'd fully support changing that to something more meaningful as well. But not the title of this PR, which isn't any better.)

ferdnyc
ferdnyc reviewed Aug 26, 2022
View reviewed changes
Copy link
Contributor

@ferdnyc ferdnyc left a comment

Choose a reason for hiding this comment

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

Added a formal Suggested Change for the apostrophe, for convenience.

merwok and others added 2 commits August 26, 2022 13:05
@merwok @ferdnyc
minor
bf20230 
Co-authored-by: Frank Dana <ferdnyc@gmail.com>
@merwok
fix wording
0611a6c
@merwok merwok changed the title bpo-46279: Fixed __main__.py documentation typo bpo-46279: Fixed __main__.py documentation wording Aug 26, 2022
merwok
merwok requested changes Aug 26, 2022
View reviewed changes
Copy link
Member

@merwok merwok left a comment

Choose a reason for hiding this comment

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

Another issue on line 242:

if __name__ == '__main__' blocks. Instead, those files are kept short,
functions to execute from other modules. Those other modules can then be

→ those files are kept short, importing functions to execute from other modules

@merwok merwok linked an issue Aug 26, 2022 that may be closed by this pull request
[docs] Minor information-ordering issue in __main__ doc #90437
Closed
@merwok merwok changed the title bpo-46279: Fixed __main__.py documentation wording gh-90437: Fix __main__.py documentation wording Aug 26, 2022
@merwok merwok removed DO-NOT-MERGE stale Stale PR or inactive for long period of time. labels Aug 26, 2022
@merwok merwok self-assigned this Aug 26, 2022
@tavallaie
Copy link
Contributor

@riqts could you please sign off on the PR and ensure it passes all the tests? This might help us move forward and resolve any blockers in the process.

@python-cla-bot
Copy link

python-cla-bot bot commented Apr 6, 2025

The following commit authors need to sign the Contributor License Agreement:

CLA signed

@python python deleted a comment Apr 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ferdnyc ferdnyc ferdnyc left review comments

@ofey404 ofey404 ofey404 left review comments

@merwok merwok merwok requested changes

@rhettinger rhettinger rhettinger requested changes

@taleinat taleinat Awaiting requested review from taleinat

Assignees

@merwok merwok

Labels
awaiting changes docs Documentation in the Doc dir skip news
Projects
Docs PRs
Status: Todo
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[docs] Minor information-ordering issue in __main__ doc
10 participants
@riqts @the-knights-who-say-ni @taleinat @bedevere-bot @merwok @ferdnyc @tavallaie @rhettinger @ofey404 @ezio-melotti