Skip to content

docs: fix description of function parameter of shutil.register_archive_format #145087

Merged
serhiy-storchaka merged 1 commit into
python:mainfrom
brianschubert:docs-shutil-registerarchiveformat
Jun 2, 2026
Merged

docs: fix description of function parameter of shutil.register_archive_format #145087
serhiy-storchaka merged 1 commit into
python:mainfrom
brianschubert:docs-shutil-registerarchiveformat

Conversation

@brianschubert
Copy link
Copy Markdown
Contributor

@brianschubert brianschubert commented Feb 21, 2026

Both register_archive_format and register_unpack_format describe their function parameter as

function is the callable that will be used to unpack archives.

The former should instead read:

function is the callable that will be used to create archives.

The docstring of register_archive_format describes it correctly:

cpython/Lib/shutil.py

Lines 1160 to 1164 in c9380ae

def register_archive_format(name, function, extra_args=None, description=''):
"""Registers an archive format.
name is the name of the format. function is the callable that will be
used to create archives. If provided, extra_args is a sequence of


📚 Documentation preview 📚: https://cpython-previews--145087.org.readthedocs.build/

@brianschubert brianschubert added docs Documentation in the Doc dir skip issue skip news needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Feb 21, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs Feb 21, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 7, 2026

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 May 7, 2026
@serhiy-storchaka serhiy-storchaka added the needs backport to 3.15 pre-release feature fixes, bugs and security fixes label May 30, 2026
Copy link
Copy Markdown
Member

@serhiy-storchaka serhiy-storchaka left a comment

Choose a reason for hiding this comment

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

LGTM. (How we did not see this?)

@github-actions github-actions Bot removed the stale Stale PR or inactive for long period of time. label Jun 2, 2026
@serhiy-storchaka serhiy-storchaka merged commit 18c6d3c into python:main Jun 2, 2026
52 checks passed
@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs Jun 2, 2026
@miss-islington-app
Copy link
Copy Markdown

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.
🐍🍒⛏🤖

@bedevere-app
Copy link
Copy Markdown

bedevere-app Bot commented Jun 2, 2026

GH-150804 is a backport of this pull request to the 3.15 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.15 pre-release feature fixes, bugs and security fixes label Jun 2, 2026
@bedevere-app
Copy link
Copy Markdown

bedevere-app Bot commented Jun 2, 2026

GH-150805 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Jun 2, 2026
@bedevere-app
Copy link
Copy Markdown

bedevere-app Bot commented Jun 2, 2026

GH-150806 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.13 bugs and security fixes label Jun 2, 2026
serhiy-storchaka pushed a commit that referenced this pull request Jun 2, 2026
…rchive_format() (GH-145087) (GH-150806)

(cherry picked from commit 18c6d3c)

Co-authored-by: Brian Schubert <brianm.schubert@gmail.com>
serhiy-storchaka pushed a commit that referenced this pull request Jun 2, 2026
…rchive_format() (GH-145087) (GH-150805)

(cherry picked from commit 18c6d3c)

Co-authored-by: Brian Schubert <brianm.schubert@gmail.com>
serhiy-storchaka pushed a commit that referenced this pull request Jun 2, 2026
…rchive_format() (GH-145087) (GH-150804)

(cherry picked from commit 18c6d3c)

Co-authored-by: Brian Schubert <brianm.schubert@gmail.com>
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

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants