bpo-41455: Fix docs according to sources and devguide #21703
Conversation
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.
|
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 usernameWe 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! |
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 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.
|
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 |
|
Thanks for making the requested changes! @pablogsal: please review the changes made to this pull request. |
|
Thanks @P-Alban for the PR, and @pablogsal for merging it |
… the GC docs (pythonGH-21703) Co-authored-by: Pablo Galindo <Pablogsal@gmail.com> (cherry picked from commit 82ca8fa) Co-authored-by: Yaroslav Pankovych <31005942+P-Alban@users.noreply.github.com>
|
GH-21786 is a backport of this pull request to the 3.9 branch. |
|
Thanks for the PR @P-Alban ! |
|
GH-21787 is a backport of this pull request to the 3.8 branch. |
|
GH-21788 is a backport of this pull request to the 3.7 branch. |
… the GC docs (pythonGH-21703) Co-authored-by: Pablo Galindo <Pablogsal@gmail.com> (cherry picked from commit 82ca8fa) Co-authored-by: Yaroslav Pankovych <31005942+P-Alban@users.noreply.github.com>
… the GC docs (pythonGH-21703) Co-authored-by: Pablo Galindo <Pablogsal@gmail.com> (cherry picked from commit 82ca8fa) Co-authored-by: Yaroslav Pankovych <31005942+P-Alban@users.noreply.github.com>
… the GC docs (pythonGH-21703) Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
… the GC docs (pythonGH-21703) Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
… the GC docs (pythonGH-21703) Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
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