Skip to content

Commit 6565742

Browse files
committed
Further expand refresh methods' docstrings
1 parent 0d6c68a commit 6565742

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

Diff for: git/cmd.py

+5-2
Original file line numberDiff line numberDiff line change
@@ -389,9 +389,12 @@ def __setstate__(self, d: Dict[str, Any]) -> None:
389389

390390
@classmethod
391391
def refresh(cls, path: Union[None, PathLike] = None) -> bool:
392-
"""This gets called by the :func:`git.refresh` function.
392+
"""Update information about the git executable :class:`Git` objects will use.
393393
394-
See the top level ``__init__.py``.
394+
Called by the :func:`git.refresh` function in the top level ``__init__``.
395+
396+
This gets called by the :func:`git.refresh` function in the top-level
397+
``__init__``.
395398
396399
:param path:
397400
Optional path to the git executable. If not absolute, it is resolved

Diff for: git/remote.py

+3-2
Original file line numberDiff line numberDiff line change
@@ -338,9 +338,10 @@ class FetchInfo(IterableObj):
338338

339339
@classmethod
340340
def refresh(cls) -> Literal[True]:
341-
"""This gets called by the :func:`git.refresh` function.
341+
"""Update information about which ``git fetch`` flags are supported by the git
342+
executable being used.
342343
343-
See the top level ``__init__.py``.
344+
Called by the :func:`git.refresh` function in the top level ``__init__``.
344345
"""
345346
# Clear the old values in _flag_map.
346347
with contextlib.suppress(KeyError):

0 commit comments

Comments
 (0)