Skip to content

bpo-41455: Fix docs according to sources and devguide #21703

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

Merged
merged 7 commits into from
Aug 8, 2020

Conversation

ypankovych
Copy link
Contributor

@ypankovych ypankovych commented Aug 2, 2020

I've noticed that python docs differ from devguide (https://github.com/python/devguide/blob/master/garbage_collector.rst#collecting-the-oldest-generation)
and source code (https://github.com/python/cpython/blob/master/Modules/gcmodule.c#L1409).

So, I decided to fix python docs according to those sources (actually still not quite sure if it's correct now, but we definitely should make some changes).

This is my first contribution, so any critic is welcome.

https://bugs.python.org/issue41455

I've noticed that python docs differs from devguide (https://github.com/python/devguide/blob/master/garbage_collector.rst#collecting-the-oldest-generation)
and source code (https://github.com/python/cpython/blob/master/Modules/gcmodule.c#L1409). 

So, I decided to fix python docs according to those sources. This is my first contribution, so any critic are welcome.
@ypankovych ypankovych requested a review from pablogsal as a code owner August 2, 2020 08:36
@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).

Recognized GitHub username

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

@P-Alban

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!

Copy link
Contributor

@remilapeyre remilapeyre left a comment

Choose a reason for hiding this comment

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

Hi @P-Alban, welcome to contributing to Python 🎉 !

As @the-knights-who-say-ni said, you will need to sign the CLA before this change can be merged. Please follow the instructions in his message to do so.

Also in the documentation the lines are wrapped at the 80-th column. Can you please update your pull request so that lines are wrapped accordingly and match the style of the rest of the file?

@ypankovych
Copy link
Contributor Author

Hi @P-Alban, welcome to contributing to Python 🎉 !

As @the-knights-who-say-ni said, you will need to sign the CLA before this change can be merged. Please follow the instructions in his message to do so.

Also in the documentation the lines are wrapped at the 80-th column. Can you please update your pull request so that lines are wrapped accordingly and match the style of the rest of the file?

Yeah, I've already signed CLA, but as it says, I should wait one business day for confirmation.
I'll fix my MR right now, thanks.

Copy link
Member

@pablogsal pablogsal left a comment

Choose a reason for hiding this comment

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

I think this may be too verbose for the documentation. In my opinion, we don't need to explain here why this is (maybe provide a link to the devguide) we just need to say that it happens.

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

@ypankovych
Copy link
Contributor Author

I have made the requested changes; please review again

@bedevere-bot
Copy link

Thanks for making the requested changes!

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

@bedevere-bot bedevere-bot requested a review from pablogsal August 8, 2020 13:20
@pablogsal pablogsal merged commit 82ca8fa into python:master Aug 8, 2020
@miss-islington
Copy link
Contributor

Thanks @P-Alban for the PR, and @pablogsal for merging it 🌮🎉.. I'm working now to backport this PR to: 3.7, 3.8, 3.9.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 8, 2020
… the GC docs (pythonGH-21703)

Co-authored-by: Pablo Galindo <[email protected]>
(cherry picked from commit 82ca8fa)

Co-authored-by: Yaroslav Pankovych <[email protected]>
@bedevere-bot
Copy link

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

@bedevere-bot bedevere-bot removed the needs backport to 3.9 only security fixes label Aug 8, 2020
@pablogsal
Copy link
Member

Thanks for the PR @P-Alban !

@bedevere-bot
Copy link

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

@bedevere-bot
Copy link

GH-21788 is a backport of this pull request to the 3.7 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 8, 2020
… the GC docs (pythonGH-21703)

Co-authored-by: Pablo Galindo <[email protected]>
(cherry picked from commit 82ca8fa)

Co-authored-by: Yaroslav Pankovych <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 8, 2020
… the GC docs (pythonGH-21703)

Co-authored-by: Pablo Galindo <[email protected]>
(cherry picked from commit 82ca8fa)

Co-authored-by: Yaroslav Pankovych <[email protected]>
miss-islington added a commit that referenced this pull request Aug 8, 2020
… the GC docs (GH-21703)

Co-authored-by: Pablo Galindo <[email protected]>
(cherry picked from commit 82ca8fa)

Co-authored-by: Yaroslav Pankovych <[email protected]>
miss-islington added a commit that referenced this pull request Aug 8, 2020
… the GC docs (GH-21703)

Co-authored-by: Pablo Galindo <[email protected]>
(cherry picked from commit 82ca8fa)

Co-authored-by: Yaroslav Pankovych <[email protected]>
ned-deily pushed a commit that referenced this pull request Aug 12, 2020
… the GC docs (GH-21703) (GH-21788)

Co-authored-by: Pablo Galindo <[email protected]>
(cherry picked from commit 82ca8fa)

Co-authored-by: Yaroslav Pankovych <[email protected]>
shihai1991 pushed a commit to shihai1991/cpython that referenced this pull request Aug 20, 2020
xzy3 pushed a commit to xzy3/cpython that referenced this pull request Oct 18, 2020
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 news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants