Skip to content

Commit

Permalink
Fix typos and further clarify Git.refresh docstring
Browse files Browse the repository at this point in the history
This further improves the text previously introduced in gitpython-developers#1829 and
improved in gitpython-developers#1844.
  • Loading branch information
EliahKagan committed Feb 26, 2024
1 parent fe1934c commit 9b5531b
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions git/cmd.py
Original file line number Diff line number Diff line change
Expand Up @@ -379,8 +379,8 @@ def refresh(cls, path: Union[None, PathLike] = None) -> bool:
:note: The top-level :func:`git.refresh` should be preferred because it calls
this method and may also update other state accordingly.
:note: There are three different ways to specify what command refreshing causes
to be uses for git:
:note: There are three different ways to specify the command that refreshing
causes to be used for git:
1. Pass no *path* argument and do not set the ``GIT_PYTHON_GIT_EXECUTABLE``
environment variable. The command name ``git`` is used. It is looked up
Expand All @@ -394,9 +394,9 @@ def refresh(cls, path: Union[None, PathLike] = None) -> bool:
in each command run. Setting ``GIT_PYTHON_GIT_EXECUTABLE`` to ``git`` has
the same effect as not setting it.
3. Pass a *path* argument. This path, if not absolute, it immediately
3. Pass a *path* argument. This path, if not absolute, is immediately
resolved, relative to the current directory. This resolution occurs at
the time of the refresh, and when git commands are run, they are run with
the time of the refresh. When git commands are run, they are run using
that previously resolved path. If a *path* argument is passed, the
``GIT_PYTHON_GIT_EXECUTABLE`` environment variable is not consulted.
Expand Down

0 comments on commit 9b5531b

Please sign in to comment.