Skip to content

Commit a374b8c

Browse files
committed
Revise docstrings in git.__init__ and git.cmd
Mainly for formatting.
1 parent 6e1dddd commit a374b8c

File tree

2 files changed

+139
-91
lines changed

2 files changed

+139
-91
lines changed

git/__init__.py

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -122,18 +122,22 @@
122122
def refresh(path: Optional[PathLike] = None) -> None:
123123
"""Convenience method for setting the git executable path.
124124
125-
:param path: Optional path to the Git executable. If not absolute, it is resolved
125+
:param path:
126+
Optional path to the Git executable. If not absolute, it is resolved
126127
immediately, relative to the current directory.
127128
128-
:note: The *path* parameter is usually omitted and cannot be used to specify a
129-
custom command whose location is looked up in a path search on each call. See
129+
:note:
130+
The *path* parameter is usually omitted and cannot be used to specify a custom
131+
command whose location is looked up in a path search on each call. See
130132
:meth:`Git.refresh` for details on how to achieve this.
131133
132-
:note: This calls :meth:`Git.refresh` and sets other global configuration according
133-
to the effect of doing so. As such, this function should usually be used instead
134-
of using :meth:`Git.refresh` or :meth:`FetchInfo.refresh` directly.
134+
:note:
135+
This calls :meth:`Git.refresh` and sets other global configuration according to
136+
the effect of doing so. As such, this function should usually be used instead of
137+
using :meth:`Git.refresh` or :meth:`FetchInfo.refresh` directly.
135138
136-
:note: This function is called automatically, with no arguments, at import time.
139+
:note:
140+
This function is called automatically, with no arguments, at import time.
137141
"""
138142
global GIT_OK
139143
GIT_OK = False

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy