Skip to content

gh-98996: Fix formatting in shutil.make_archive docs #98997

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 5 commits into from
Closed

gh-98996: Fix formatting in shutil.make_archive docs #98997

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fe422af
Fixed Issue 98996 by correcting the formating in the documentation
Mukund-Tandon Nov 2, 2022
3c20796
Merge branch 'main' into issue_98996
Mukund-Tandon Nov 2, 2022
4a204eb
Removed trailing white spaces
Mukund-Tandon Nov 2, 2022
577f0b3
Merge branch 'main' of github.com:Mukund-Tandon/cpython into issue_98996
Mukund-Tandon Nov 2, 2022
2078a8d
Merge branch 'issue_98996' of github.com:Mukund-Tandon/cpython into i…
Mukund-Tandon Nov 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions Doc/library/shutil.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -542,10 +542,11 @@ 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
"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).
any format-specific extension.

*format* is the archive format: one of "zip" (if the :mod:`zlib` module
Copy link
Contributor

Choose a reason for hiding this comment

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

To aid reviews, I would keep this paragraph in the same format as it was before (i.e., wrapped the same way except the first line). It'll be easier for reviews to more easily see the diffs that way.

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).

*root_dir* is a directory that will be the root directory of the
archive, all paths in the archive will be relative to it; for example,
Expand Down