Skip to content

Commit

Permalink
Fix up Remote.push docstring
Browse files Browse the repository at this point in the history
- 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.
  • Loading branch information
EliahKagan committed Feb 24, 2024
1 parent a33b800 commit 9b12b58
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions git/remote.py
Original file line number Diff line number Diff line change
Expand Up @@ -1075,13 +1075,14 @@ def push(
:param progress:
Can take one of many value types:
* None to discard progress information.
* None, to discard progress information.
* A function (callable) that is called with the progress information.
Signature: ``progress(op_code, cur_count, max_count=None, message='')``.
`Click here <http://goo.gl/NPa7st>`__ for a description of all arguments
given to the function.
* An instance of a class derived from :class:`git.RemoteProgress` that
overrides the :meth:`~git.RemoteProgress.update` method.
See :meth:`RemoteProgress.update <git.util.RemoteProgress.update>` for a
description of all arguments given to the function.
* An instance of a class derived from :class:`~git.util.RemoteProgress` that
overrides the
:meth:`RemoteProgress.update <git.util.RemoteProgress.update>` method.
:note: No further progress information is returned after push returns.
Expand Down

0 comments on commit 9b12b58

Please sign in to comment.