Skip to content

Commit fa471fe

Browse files
committed
Fix up Remote.push docstring
- Replace the goo.gl web shortlink with a Sphinx reference that displays and also (in built documentation) becomes a hyperlink to the documentation on the method being referred to. - Refer to a related class (which is in another module) as being in the module where it is defined, rather than in the top-level git module (where it also can be accessed because it is imported there, which is reasonable to do, but less clear documentation). - Tweak punctuation so the effect of passing None is a bit clearer.
1 parent f56e1ac commit fa471fe

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

git/remote.py

+6-5
Original file line numberDiff line numberDiff line change
@@ -1075,13 +1075,14 @@ def push(
10751075
:param progress:
10761076
Can take one of many value types:
10771077
1078-
* None to discard progress information.
1078+
* None, to discard progress information.
10791079
* A function (callable) that is called with the progress information.
10801080
Signature: ``progress(op_code, cur_count, max_count=None, message='')``.
1081-
`Click here <http://goo.gl/NPa7st>`__ for a description of all arguments
1082-
given to the function.
1083-
* An instance of a class derived from :class:`git.RemoteProgress` that
1084-
overrides the :meth:`~git.RemoteProgress.update` method.
1081+
See :meth:`RemoteProgress.update <git.util.RemoteProgress.update>` for a
1082+
description of all arguments given to the function.
1083+
* An instance of a class derived from :class:`~git.util.RemoteProgress` that
1084+
overrides the
1085+
:meth:`RemoteProgress.update <git.util.RemoteProgress.update>` method.
10851086
10861087
:note: No further progress information is returned after push returns.
10871088

0 commit comments

Comments
 (0)