summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2024-02-02 10:28:32 (GMT)
committerGitHub <noreply@github.com>2024-02-02 10:28:32 (GMT)
commit8cb7e5cc7c495a873964dc7ba1ac9662654ded75 (patch)
tree308dc1eaa31231817b0739ac701659631ec31613 /Doc
parentcc5870a1d7041d784ce01774fab351e6feb36370 (diff)
downloadcpython-8cb7e5cc7c495a873964dc7ba1ac9662654ded75.zip
cpython-8cb7e5cc7c495a873964dc7ba1ac9662654ded75.tar.gz
cpython-8cb7e5cc7c495a873964dc7ba1ac9662654ded75.tar.bz2
[3.12] Move "format" param doc of shutil.make_archive() on its own paragraph (GH-103829) (GH-114897)
(cherry picked from commit 53339a0ef72fcfc15221792b117c4670b07a0b20) Co-authored-by: Michal Kaptur <kaptur.michal@gmail.com>
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/shutil.rst4
1 files changed, 3 insertions, 1 deletions
diff --git a/Doc/library/shutil.rst b/Doc/library/shutil.rst
index b49cdd3..7e32a1f 100644
--- a/Doc/library/shutil.rst
+++ b/Doc/library/shutil.rst
@@ -580,7 +580,9 @@ provided. They rely on the :mod:`zipfile` and :mod:`tarfile` modules.
Create an archive file (such as zip or tar) and return its name.
*base_name* is the name of the file to create, including the path, minus
- any format-specific extension. *format* is the archive format: one of
+ any format-specific extension.
+
+ *format* is the archive format: one of
"zip" (if the :mod:`zlib` module is available), "tar", "gztar" (if the
:mod:`zlib` module is available), "bztar" (if the :mod:`bz2` module is
available), or "xztar" (if the :mod:`lzma` module is available).