Skip to content

Commit b8ebff8

Browse files
committed
Suggest full-path refresh() in failure message
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).
1 parent 7d96a1a commit b8ebff8

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

Diff for: git/cmd.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -438,7 +438,7 @@ def refresh(cls, path: Union[None, PathLike] = None) -> bool:
438438
The git executable must be specified in one of the following ways:
439439
- be included in your $PATH
440440
- be set via $%s
441-
- explicitly set via git.refresh()
441+
- explicitly set via git.refresh("/full/path/to/git")
442442
"""
443443
)
444444
% cls._git_exec_env_var

0 commit comments

Comments
 (0)