Skip to content

Commit

Permalink
Revise docstrings in git.__init__ and git.cmd
Browse files Browse the repository at this point in the history
Mainly for formatting.
  • Loading branch information
EliahKagan committed Feb 24, 2024
1 parent 6e1dddd commit a374b8c
Show file tree
Hide file tree
Showing 2 changed files with 139 additions and 91 deletions.
18 changes: 11 additions & 7 deletions git/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -122,18 +122,22 @@
def refresh(path: Optional[PathLike] = None) -> None:
"""Convenience method for setting the git executable path.
:param path: Optional path to the Git executable. If not absolute, it is resolved
:param path:
Optional path to the Git executable. If not absolute, it is resolved
immediately, relative to the current directory.
:note: The *path* parameter is usually omitted and cannot be used to specify a
custom command whose location is looked up in a path search on each call. See
:note:
The *path* parameter is usually omitted and cannot be used to specify a custom
command whose location is looked up in a path search on each call. See
:meth:`Git.refresh` for details on how to achieve this.
:note: This calls :meth:`Git.refresh` and sets other global configuration according
to the effect of doing so. As such, this function should usually be used instead
of using :meth:`Git.refresh` or :meth:`FetchInfo.refresh` directly.
:note:
This calls :meth:`Git.refresh` and sets other global configuration according to
the effect of doing so. As such, this function should usually be used instead of
using :meth:`Git.refresh` or :meth:`FetchInfo.refresh` directly.
:note: This function is called automatically, with no arguments, at import time.
:note:
This function is called automatically, with no arguments, at import time.
"""
global GIT_OK
GIT_OK = False
Expand Down
Loading

0 comments on commit a374b8c

Please sign in to comment.