Merge pull request #1850 from EliahKagan/copyedit

Revise docstrings, comments, and a few messages

Author: Byron

Diff for: git/__init__.py

@@ -122,18 +122,23 @@
 def refresh(path: Optional[PathLike] = None) -> None:
     """Convenience method for setting the git executable path.
 
-    :param path: Optional path to the Git executable. If not absolute, it is resolved
+    :param path:
+        Optional path to the Git executable. If not absolute, it is resolved
         immediately, relative to the current directory.
 
-    :note: The *path* parameter is usually omitted and cannot be used to specify a
-        custom command whose location is looked up in a path search on each call. See
-        :meth:`Git.refresh` for details on how to achieve this.
+    :note:
+        The `path` parameter is usually omitted and cannot be used to specify a custom
+        command whose location is looked up in a path search on each call. See
+        :meth:`Git.refresh <git.cmd.Git.refresh>` for details on how to achieve this.
 
-    :note: This calls :meth:`Git.refresh` and sets other global configuration according
-        to the effect of doing so. As such, this function should usually be used instead
-        of using :meth:`Git.refresh` or :meth:`FetchInfo.refresh` directly.
+    :note:
+        This calls :meth:`Git.refresh <git.cmd.Git.refresh>` and sets other global
+        configuration according to the effect of doing so. As such, this function should
+        usually be used instead of using :meth:`Git.refresh <git.cmd.Git.refresh>` or
+        :meth:`FetchInfo.refresh <git.remote.FetchInfo.refresh>` directly.
 
-    :note: This function is called automatically, with no arguments, at import time.
+    :note:
+        This function is called automatically, with no arguments, at import time.
     """
     global GIT_OK
     GIT_OK = False

Diff for: git/cmd.py

@@ -35,8 +35,9 @@
 :attr:`sys.platform` checks explicitly, especially in cases where it matters which is
 used.
 
-:note: ``is_win`` is ``False`` on Cygwin, but is often wrongly assumed ``True``. To
-    detect Cygwin, use ``sys.platform == "cygwin"``.
+:note:
+    ``is_win`` is ``False`` on Cygwin, but is often wrongly assumed ``True``. To detect
+    Cygwin, use ``sys.platform == "cygwin"``.
 """
 
 is_posix = os.name == "posix"
@@ -46,9 +47,10 @@
 :attr:`sys.platform` checks explicitly, especially in cases where it matters which is
 used.
 
-:note: For POSIX systems, more detailed information is available in
-    :attr:`sys.platform`, while :attr:`os.name` is always ``"posix"`` on such systems,
-    including macOS (Darwin).
+:note:
+    For POSIX systems, more detailed information is available in :attr:`sys.platform`,
+    while :attr:`os.name` is always ``"posix"`` on such systems, including macOS
+    (Darwin).
 """
 
 is_darwin = sys.platform == "darwin"
@@ -57,7 +59,8 @@
 This is deprecated because it clearer to write out :attr:`os.name` or
 :attr:`sys.platform` checks explicitly.
 
-:note: For macOS (Darwin), ``os.name == "posix"`` as in other Unix-like systems, while
+:note:
+    For macOS (Darwin), ``os.name == "posix"`` as in other Unix-like systems, while
     ``sys.platform == "darwin"`.
 """
 

Diff for: git/compat.py

@@ -30,9 +30,6 @@ class GitCmdObjectDB(LooseObjectDB):
     objects, pack files and an alternates file.
 
     It will create objects only in the loose object database.
-
-    :note: For now, we use the git command to do all the lookup, just until we
-        have packs and the other implementations.
     """
 
     def __init__(self, root_path: PathLike, git: "Git") -> None:
@@ -53,13 +50,16 @@ def stream(self, binsha: bytes) -> OStream:
 
     def partial_to_complete_sha_hex(self, partial_hexsha: str) -> bytes:
         """
-        :return: Full binary 20 byte sha from the given partial hexsha
+        :return:
+            Full binary 20 byte sha from the given partial hexsha
+
+        :raise gitdb.exc.AmbiguousObjectName:
 
-        :raise AmbiguousObjectName:
-        :raise BadObject:
+        :raise gitdb.exc.BadObject:
 
-        :note: Currently we only raise :class:`BadObject` as git does not communicate
-            AmbiguousObjects separately.
+        :note:
+            Currently we only raise :class:`~gitdb.exc.BadObject` as git does not
+            communicate ambiguous objects separately.
         """
         try:
             hexsha, _typename, _size = self._git.get_object_header(partial_hexsha)

Diff for: git/config.py

@@ -84,8 +84,9 @@ class Diffable:
     compatible type.
 
     :note:
-        Subclasses require a repo member as it is the case for Object instances, for
-        practical reasons we do not derive from Object.
+        Subclasses require a repo member as it is the case for
+        :class:`~git.objects.base.Object` instances, for practical reasons we do not
+        derive from :class:`~git.objects.base.Object`.
     """
 
     __slots__ = ()
@@ -111,37 +112,38 @@ def diff(
         create_patch: bool = False,
         **kwargs: Any,
     ) -> "DiffIndex":
-        """Create diffs between two items being trees, trees and index or an
-        index and the working tree. Detects renames automatically.
+        """Create diffs between two items being trees, trees and index or an index and
+        the working tree. Detects renames automatically.
 
         :param other:
             This the item to compare us with.
 
-            * If None, we will be compared to the working tree.
+            * If ``None``, we will be compared to the working tree.
             * If :class:`~git.index.base.Treeish`, it will be compared against the
               respective tree.
-            * If :class:`~Diffable.Index`, it will be compared against the index.
+            * If :class:`Diffable.Index`, it will be compared against the index.
             * If :attr:`git.NULL_TREE`, it will compare against the empty tree.
-            * It defaults to :class:`~Diffable.Index` so that the method will not by
+            * It defaults to :class:`Diffable.Index` so that the method will not by
               default fail on bare repositories.
 
         :param paths:
             This a list of paths or a single path to limit the diff to. It will only
             include at least one of the given path or paths.
 
         :param create_patch:
-            If True, the returned :class:`Diff` contains a detailed patch that if
+            If ``True``, the returned :class:`Diff` contains a detailed patch that if
             applied makes the self to other. Patches are somewhat costly as blobs have
             to be read and diffed.
 
         :param kwargs:
-            Additional arguments passed to git-diff, such as ``R=True`` to swap both
+            Additional arguments passed to ``git diff``, such as ``R=True`` to swap both
             sides of the diff.
 
-        :return: git.DiffIndex
+        :return:
+            :class:`DiffIndex`
 
         :note:
-            On a bare repository, 'other' needs to be provided as
+            On a bare repository, `other` needs to be provided as
             :class:`~Diffable.Index`, or as :class:`~git.objects.tree.Tree` or
             :class:`~git.objects.commit.Commit`, or a git command error will occur.
         """
@@ -184,7 +186,7 @@ def diff(
 
         args.insert(0, self)
 
-        # paths is list here, or None.
+        # paths is a list here, or None.
         if paths:
             args.append("--")
             args.extend(paths)
@@ -204,7 +206,7 @@ def diff(
 
 
 class DiffIndex(List[T_Diff]):
-    """An Index for diffs, allowing a list of Diffs to be queried by the diff
+    R"""An Index for diffs, allowing a list of :class:`Diff`\s to be queried by the diff
     properties.
 
     The class improves the diff handling convenience.
@@ -256,34 +258,34 @@ def iter_change_type(self, change_type: Lit_change_type) -> Iterator[T_Diff]:
 class Diff:
     """A Diff contains diff information between two Trees.
 
-    It contains two sides a and b of the diff, members are prefixed with
-    "a" and "b" respectively to indicate that.
+    It contains two sides a and b of the diff. Members are prefixed with "a" and "b"
+    respectively to indicate that.
 
     Diffs keep information about the changed blob objects, the file mode, renames,
     deletions and new files.
 
-    There are a few cases where None has to be expected as member variable value:
+    There are a few cases where ``None`` has to be expected as member variable value:
 
-    ``New File``::
+    New File::
 
         a_mode is None
         a_blob is None
         a_path is None
 
-    ``Deleted File``::
+    Deleted File::
 
         b_mode is None
         b_blob is None
         b_path is None
 
-    ``Working Tree Blobs``
+    Working Tree Blobs:
 
         When comparing to working trees, the working tree blob will have a null hexsha
-        as a corresponding object does not yet exist. The mode will be null as well.
-        The path will be available, though.
+        as a corresponding object does not yet exist. The mode will be null as well. The
+        path will be available, though.
 
-        If it is listed in a diff, the working tree version of the file must
-        differ from the version in the index or tree, and hence has been modified.
+        If it is listed in a diff, the working tree version of the file must differ from
+        the version in the index or tree, and hence has been modified.
     """
 
     # Precompiled regex.
@@ -467,17 +469,20 @@ def rename_to(self) -> Optional[str]:
 
     @property
     def renamed(self) -> bool:
-        """
-        :return: True if the blob of our diff has been renamed
+        """Deprecated, use :attr:`renamed_file` instead.
+
+        :return:
+            ``True`` if the blob of our diff has been renamed
 
-        :note: This property is deprecated.
+        :note:
+            This property is deprecated.
             Please use the :attr:`renamed_file` property instead.
         """
         return self.renamed_file
 
     @property
     def renamed_file(self) -> bool:
-        """:return: True if the blob of our diff has been renamed"""
+        """:return: ``True`` if the blob of our diff has been renamed"""
         return self.rename_from != self.rename_to
 
     @classmethod
@@ -495,11 +500,18 @@ def _pick_best_path(cls, path_match: bytes, rename_match: bytes, path_fallback_m
 
     @classmethod
     def _index_from_patch_format(cls, repo: "Repo", proc: Union["Popen", "Git.AutoInterrupt"]) -> DiffIndex:
-        """Create a new DiffIndex from the given process output which must be in patch format.
+        """Create a new :class:`DiffIndex` from the given process output which must be
+        in patch format.
+
+        :param repo:
+            The repository we are operating on.
 
-        :param repo: The repository we are operating on
-        :param proc: ``git diff`` process to read from (supports :class:`Git.AutoInterrupt` wrapper)
-        :return: git.DiffIndex
+        :param proc:
+            ``git diff`` process to read from
+            (supports :class:`Git.AutoInterrupt <git.cmd.Git.AutoInterrupt>` wrapper).
+
+        :return:
+            :class:`DiffIndex`
         """
 
         # FIXME: Here SLURPING raw, need to re-phrase header-regexes linewise.
@@ -540,14 +552,14 @@ def _index_from_patch_format(cls, repo: "Repo", proc: Union["Popen", "Git.AutoIn
             a_path = cls._pick_best_path(a_path, rename_from, a_path_fallback)
             b_path = cls._pick_best_path(b_path, rename_to, b_path_fallback)
 
-            # Our only means to find the actual text is to see what has not been matched by our regex,
-            # and then retro-actively assign it to our index.
+            # Our only means to find the actual text is to see what has not been matched
+            # by our regex, and then retro-actively assign it to our index.
             if previous_header is not None:
                 index[-1].diff = text[previous_header.end() : _header.start()]
             # END assign actual diff
 
-            # Make sure the mode is set if the path is set. Otherwise the resulting blob is invalid.
-            # We just use the one mode we should have parsed.
+            # Make sure the mode is set if the path is set. Otherwise the resulting blob
+            # is invalid. We just use the one mode we should have parsed.
             a_mode = old_mode or deleted_file_mode or (a_path and (b_mode or new_mode or new_file_mode))
             b_mode = b_mode or new_mode or new_file_mode or (b_path and a_mode)
             index.append(
@@ -611,7 +623,7 @@ def _handle_diff_line(lines_bytes: bytes, repo: "Repo", index: DiffIndex) -> Non
             rename_from = None
             rename_to = None
 
-            # NOTE: We cannot conclude from the existence of a blob to change type
+            # NOTE: We cannot conclude from the existence of a blob to change type,
             # as diffs with the working do not have blobs yet.
             if change_type == "D":
                 b_blob_id = None  # Optional[str]
@@ -655,11 +667,17 @@ def _handle_diff_line(lines_bytes: bytes, repo: "Repo", index: DiffIndex) -> Non
 
     @classmethod
     def _index_from_raw_format(cls, repo: "Repo", proc: "Popen") -> "DiffIndex":
-        """Create a new DiffIndex from the given process output which must be in raw format.
+        """Create a new :class:`DiffIndex` from the given process output which must be
+        in raw format.
+
+        :param repo:
+            The repository we are operating on.
 
-        :param repo: The repository we are operating on
-        :param proc: Process to read output from
-        :return: git.DiffIndex
+        :param proc:
+            Process to read output from.
+
+        :return:
+            :class:`DiffIndex`
         """
         # handles
         # :100644 100644 687099101... 37c5e30c8... M    .gitignore

Diff for: git/db.py

@@ -81,16 +81,20 @@ class UnsafeOptionError(GitError):
 
 
 class CommandError(GitError):
-    """Base class for exceptions thrown at every stage of `Popen()` execution.
+    """Base class for exceptions thrown at every stage of :class:`~subprocess.Popen`
+    execution.
 
     :param command:
         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,
@@ -132,8 +136,8 @@ def __str__(self) -> str:
 
 
 class GitCommandNotFound(CommandError):
-    """Thrown if we cannot find the `git` executable in the PATH or at the path given by
-    the GIT_PYTHON_GIT_EXECUTABLE environment variable."""
+    """Thrown if we cannot find the ``git`` executable in the :envvar:`PATH` or at the
+    path given by the :envvar:`GIT_PYTHON_GIT_EXECUTABLE` environment variable."""
 
     def __init__(self, command: Union[List[str], Tuple[str], str], cause: Union[str, Exception]) -> None:
         super().__init__(command, cause)
@@ -184,7 +188,7 @@ def __str__(self) -> str:
 
 
 class CacheError(GitError):
-    """Base for all errors related to the git index, which is called cache
+    """Base for all errors related to the git index, which is called "cache"
     internally."""