Show full-path refresh() in failure message differently

EliahKagan · EliahKagan · commit 0392abe9225a · 2024-02-24T21:21:54.000-05:00
This presents it more symbolically, rather than in an example-like style that could confuse. See discussion in gitpython-developers#1844.
diff --git a/git/cmd.py b/git/cmd.py
@@ -458,7 +458,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("/full/path/to/git")
+                    - explicitly set via git.refresh(<full-path-to-git-executable>)
                 """
                 )
                 % cls._git_exec_env_var

Original file line number	Diff line number	Diff line change
`@@ -458,7 +458,7 @@ def refresh(cls, path: Union[None, PathLike] = None) -> bool:`
`458`	`458`	`The git executable must be specified in one of the following ways:`
`459`	`459`	`- be included in your $PATH`
`460`	`460`	`- be set via $%s`
`461`		`- - explicitly set via git.refresh("/full/path/to/git")`
	`461`	`+ - explicitly set via git.refresh(<full-path-to-git-executable>)`
`462`	`462`	`"""`
`463`	`463`	`)`
`464`	`464`	`% cls._git_exec_env_var`