Skip to content

Expand what is included in the API Reference #1855

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Mar 2, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Fix ref to git.refresh in refresh methods' docstrings
  • Loading branch information
EliahKagan committed Mar 1, 2024
commit 0d6c68af35d1d4a9da95b189db1da68fdcee40b8
4 changes: 3 additions & 1 deletion git/cmd.py
Original file line number Diff line number Diff line change
Expand Up @@ -389,7 +389,9 @@ def __setstate__(self, d: Dict[str, Any]) -> None:

@classmethod
def refresh(cls, path: Union[None, PathLike] = None) -> bool:
"""This gets called by the refresh function (see the top level ``__init__``).
"""This gets called by the :func:`git.refresh` function.

See the top level ``__init__.py``.

:param path:
Optional path to the git executable. If not absolute, it is resolved
Expand Down
5 changes: 4 additions & 1 deletion git/remote.py
Original file line number Diff line number Diff line change
Expand Up @@ -338,7 +338,10 @@ class FetchInfo(IterableObj):

@classmethod
def refresh(cls) -> Literal[True]:
"""This gets called by the refresh function (see the top level ``__init__``)."""
"""This gets called by the :func:`git.refresh` function.

See the top level ``__init__.py``.
"""
# Clear the old values in _flag_map.
with contextlib.suppress(KeyError):
del cls._flag_map["t"]
Expand Down