Mercurial > hg
changeset 26440:85b992177d2a
exchange: add docstring to pull()
This seems like the kind of important function that should be documented
better.
| author | Gregory Szorc <gregory.szorc@gmail.com> |
|---|---|
| date | Fri, 02 Oct 2015 15:36:00 -0700 |
| parents | b50f5beadf3e |
| children | 56527b886d1d |
| files | mercurial/exchange.py |
| diffstat | 1 files changed, 15 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/mercurial/exchange.py Fri Sep 25 12:28:12 2015 -0700 +++ b/mercurial/exchange.py Fri Oct 02 15:36:00 2015 -0700 @@ -926,6 +926,21 @@ self._tr.release() def pull(repo, remote, heads=None, force=False, bookmarks=(), opargs=None): + """Fetch repository data from a remote. + + This is the main function used to retrieve data from a remote repository. + + ``repo`` is the local repository to clone into. + ``remote`` is a peer instance. + ``heads`` is an iterable of revisions we want to pull. ``None`` (the + default) means to pull everything from the remote. + ``bookmarks`` is an iterable of bookmarks requesting to be pulled. By + default, all remote bookmarks are pulled. + ``opargs`` are additional keyword arguments to pass to ``pulloperation`` + initialization. + + Returns the ``pulloperation`` created for this pull. + """ if opargs is None: opargs = {} pullop = pulloperation(repo, remote, heads, force, bookmarks=bookmarks,