docs: fix description of function parameter of shutil.register_archive_format #145087
Merged
serhiy-storchaka merged 1 commit intoJun 2, 2026
Merged
Conversation
aisk
approved these changes
Feb 22, 2026
|
This PR is stale because it has been open for 30 days with no activity. |
serhiy-storchaka
approved these changes
Jun 2, 2026
Member
serhiy-storchaka
left a comment
There was a problem hiding this comment.
LGTM. (How we did not see this?)
|
Thanks @brianschubert for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14, 3.15. |
|
GH-150804 is a backport of this pull request to the 3.15 branch. |
|
GH-150805 is a backport of this pull request to the 3.14 branch. |
|
GH-150806 is a backport of this pull request to the 3.13 branch. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Both
register_archive_formatandregister_unpack_formatdescribe their function parameter asThe former should instead read:
The docstring of
register_archive_formatdescribes it correctly:cpython/Lib/shutil.py
Lines 1160 to 1164 in c9380ae
📚 Documentation preview 📚: https://cpython-previews--145087.org.readthedocs.build/