Skip to content

Commit

Permalink
Suggest full-path refresh() in failure message
Browse files Browse the repository at this point in the history
This does not suggest or recommend *preferring* to explicitly call
refresh() over the other other techniques, but it clarifies that
the use of refresh() being presented needs a path argument. It also
shows that path in the form of a full path, so users are less
likely to be misled into thinking a command name or other relative
path should be passed to refresh(), which should rarely be done
(since refresh(path) resolves path).
  • Loading branch information
EliahKagan committed Feb 23, 2024
1 parent 7d96a1a commit b8ebff8
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion git/cmd.py
Original file line number Diff line number Diff line change
Expand Up @@ -438,7 +438,7 @@ def refresh(cls, path: Union[None, PathLike] = None) -> bool:
The git executable must be specified in one of the following ways:
- be included in your $PATH
- be set via $%s
- explicitly set via git.refresh()
- explicitly set via git.refresh("/full/path/to/git")
"""
)
% cls._git_exec_env_var
Expand Down

0 comments on commit b8ebff8

Please sign in to comment.