##// END OF EJS Templates
exchange: add docstring to pull()...
Gregory Szorc -
r26440:85b99217 default
parent child Browse files
Show More
@@ -926,6 +926,21 b' class transactionmanager(object):'
926 926 self._tr.release()
927 927
928 928 def pull(repo, remote, heads=None, force=False, bookmarks=(), opargs=None):
929 """Fetch repository data from a remote.
930
931 This is the main function used to retrieve data from a remote repository.
932
933 ``repo`` is the local repository to clone into.
934 ``remote`` is a peer instance.
935 ``heads`` is an iterable of revisions we want to pull. ``None`` (the
936 default) means to pull everything from the remote.
937 ``bookmarks`` is an iterable of bookmarks requesting to be pulled. By
938 default, all remote bookmarks are pulled.
939 ``opargs`` are additional keyword arguments to pass to ``pulloperation``
940 initialization.
941
942 Returns the ``pulloperation`` created for this pull.
943 """
929 944 if opargs is None:
930 945 opargs = {}
931 946 pullop = pulloperation(repo, remote, heads, force, bookmarks=bookmarks,
General Comments 0
You need to be logged in to leave comments. Login now