Skip to content

Comments

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

Open
brianschubert wants to merge 1 commit intopython:mainfrom
brianschubert:docs-shutil-registerarchiveformat
Open

docs: fix description of function parameter of shutil.register_archive_format #145087
brianschubert wants to merge 1 commit intopython:mainfrom
brianschubert:docs-shutil-registerarchiveformat

Conversation

@brianschubert
Copy link
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting core review docs Documentation in the Doc dir needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes skip issue skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

2 participants