Skip to content

Commit 8344f44

Browse files
committed
Revise Repo.archive docstring
I had missed this in b2b6f7c.
1 parent 0231b74 commit 8344f44

File tree

1 file changed

+17
-10
lines changed

1 file changed

+17
-10
lines changed

git/repo/base.py

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1535,22 +1535,29 @@ def archive(
15351535
) -> Repo:
15361536
"""Archive the tree at the given revision.
15371537
1538-
:param ostream: file compatible stream object to which the archive will be written as bytes.
1538+
:param ostream:
1539+
File-compatible stream object to which the archive will be written as bytes.
15391540
1540-
:param treeish: is the treeish name/id, defaults to active branch.
1541+
:param treeish:
1542+
The treeish name/id, defaults to active branch.
15411543
1542-
:param prefix: is the optional prefix to prepend to each filename in the archive.
1544+
:param prefix:
1545+
The optional prefix to prepend to each filename in the archive.
15431546
1544-
:param kwargs: Additional arguments passed to git-archive:
1547+
:param kwargs:
1548+
Additional arguments passed to ``git archive``:
15451549
1546-
* Use the 'format' argument to define the kind of format. Use
1547-
specialized ostreams to write any format supported by python.
1548-
* You may specify the special **path** keyword, which may either be a repository-relative
1549-
path to a directory or file to place into the archive, or a list or tuple of multiple paths.
1550+
* Use the 'format' argument to define the kind of format. Use specialized
1551+
ostreams to write any format supported by Python.
1552+
* You may specify the special **path** keyword, which may either be a
1553+
repository-relative path to a directory or file to place into the archive,
1554+
or a list or tuple of multiple paths.
15501555
1551-
:raise GitCommandError: If something went wrong.
1556+
:raise GitCommandError:
1557+
If something went wrong.
15521558
1553-
:return: self
1559+
:return:
1560+
self
15541561
"""
15551562
if treeish is None:
15561563
treeish = self.head.commit

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy