Commit 3958747
committed
Update CommandError._msg documentation
This converts it from a specially formatted comment to a docstring
(#1734), rewords for clarity, and removes the mention of unicode,
which appears to have been referring to the data type.
(GitPython no longer supports Python 2, and unicode is not a
separate type from str in Python 3, where instead str and bytes
are different types.)1 parent ba878ef commit 3958747
1 file changed
Lines changed: 6 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -87,10 +87,13 @@ class CommandError(GitError): | |||
| 87 | 87 | A non-empty list of argv comprising the command-line. | |
| 88 | 88 | """ | |
| 89 | 89 | ||
| 90 | - #: A unicode print-format with 2 `%s for `<cmdline>` and the rest, | ||
| 91 | - #: e.g. | ||
| 92 | - #: "'%s' failed%s" | ||
| 93 | 90 | _msg = "Cmd('%s') failed%s" | |
| 91 | + """Format string with 2 ``%s`` for ``<cmdline>`` and the rest. | ||
| 92 | + | ||
| 93 | + For example: ``"'%s' failed%s"`` | ||
| 94 | + | ||
| 95 | + Subclasses may override this attribute, provided it is still in this form. | ||
| 96 | + """ | ||
| 94 | 97 | ||
| 95 | 98 | def __init__( | |
| 96 | 99 | self, | |
0 commit comments