Update CommandError._msg documentation

EliahKagan · EliahKagan · commit 39587475ff47 · 2024-02-26T14:40:52.000-05:00
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.)
diff --git a/git/exc.py b/git/exc.py
@@ -87,10 +87,13 @@ class CommandError(GitError):
         A non-empty list of argv comprising the command-line.
     """
 
-    #: A unicode print-format with 2 `%s for `<cmdline>` and the rest,
-    #:  e.g.
-    #:     "'%s' failed%s"
     _msg = "Cmd('%s') failed%s"
+    """Format string with 2 ``%s`` for ``<cmdline>`` and the rest.
+
+    For example: ``"'%s' failed%s"``
+
+    Subclasses may override this attribute, provided it is still in this form.
+    """
 
     def __init__(
         self,
