Ver Fonte

Fix API documentation link target warnings

Jelmer Vernooij há 1 mês atrás
pai
commit
4bdc7f0675
5 ficheiros alterados com 11 adições e 11 exclusões
  1. 2 2
      dulwich/client.py
  2. 2 2
      dulwich/objects.py
  3. 5 5
      dulwich/porcelain.py
  4. 1 1
      dulwich/rebase.py
  5. 1 1
      dulwich/stripspace.py

+ 2 - 2
dulwich/client.py

@@ -3233,9 +3233,9 @@ def default_urllib3_manager(
       cert_reqs: SSL certificate requirements (e.g. "CERT_REQUIRED", "CERT_NONE")
 
     Returns:
-      Either pool_manager_cls (defaults to `urllib3.ProxyManager`) instance for
+      Either pool_manager_cls (defaults to ``urllib3.ProxyManager``) instance for
       proxy configurations, proxy_manager_cls
-      (defaults to `urllib3.PoolManager`) instance otherwise
+      (defaults to ``urllib3.PoolManager``) instance otherwise
 
     """
     proxy_server: str | None = None

+ 2 - 2
dulwich/objects.py

@@ -1115,7 +1115,7 @@ class Tag(ShaFile):
         """Extract the payload, signature, and signature type from this tag.
 
         Returns:
-          Tuple of (``payload``, ``signature``, ``signature_type``) where:
+          tuple of (``payload``, ``signature``, ``signature_type``) where:
 
           - ``payload``: The raw tag data without the signature
           - ``signature``: The signature bytes if present, None otherwise
@@ -1871,7 +1871,7 @@ class Commit(ShaFile):
         """Extract the payload, signature, and signature type from this commit.
 
         Returns:
-          Tuple of (``payload``, ``signature``, ``signature_type``) where:
+          tuple of (``payload``, ``signature``, ``signature_type``) where:
 
           - ``payload``: The raw commit data without the signature
           - ``signature``: The signature bytes if present, None otherwise

+ 5 - 5
dulwich/porcelain.py

@@ -445,7 +445,7 @@ def _get_reflog_message(
       explicit_message: Explicit message passed as argument (takes precedence)
 
     Returns:
-      The reflog message to use, with priority:
+      The reflog message with priority:
         1. explicit_message if provided
         2. GIT_REFLOG_ACTION environment variable if set
         3. default_message otherwise
@@ -949,7 +949,7 @@ def interpret_trailers(
 ) -> bytes:
     r"""Parse and manipulate trailers in a commit message.
 
-    This function implements the functionality of `git interpret-trailers`,
+    This function implements the functionality of ``git interpret-trailers``,
     allowing parsing and manipulation of structured metadata (trailers) in
     commit messages.
 
@@ -1044,7 +1044,7 @@ def stripspace(
 ) -> bytes:
     r"""Strip unnecessary whitespace from text.
 
-    This function implements the functionality of `git stripspace`, commonly
+    This function implements the functionality of ``git stripspace``, commonly
     used to clean up commit messages and other text content.
 
     Args:
@@ -3320,7 +3320,7 @@ def shortlog(
         sort_by_commits: If True, sort authors by number of commits.
 
     Returns:
-        A list of dictionaries, each containing:
+        A list where each item is a dict containing:
 
             - "author": the author's name as a string
             - "messages": all commit messages concatenated into a single string
@@ -4094,7 +4094,7 @@ def _get_branch_merge_status(repo: RepoPath) -> Iterator[tuple[bytes, bool]]:
         repo: Path to the repository
 
     Yields:
-        Tuple of (``branch_name``, ``is_merged``) where:
+        tuple of (``branch_name``, ``is_merged``) where:
 
         - ``branch_name``: Branch name without refs/heads/ prefix
         - ``is_merged``: True if branch is merged into HEAD, False otherwise

+ 1 - 1
dulwich/rebase.py

@@ -1065,7 +1065,7 @@ def process_interactive_rebase(
         editor_callback: Optional callback for reword operations
 
     Returns:
-        Tuple of (``is_complete``, ``pause_reason``):
+        tuple of (``is_complete``, ``pause_reason``):
 
         * ``is_complete``: True if rebase is complete, False if paused
         * ``pause_reason``: Reason for pause (e.g., "edit", "conflict", "break") or None

+ 1 - 1
dulwich/stripspace.py

@@ -29,7 +29,7 @@ def stripspace(
 ) -> bytes:
     """Strip unnecessary whitespace from text.
 
-    This function mimics the behavior of `git stripspace`, which is commonly
+    This function mimics the behavior of ``git stripspace``, which is commonly
     used to clean up commit messages and other text content.
 
     Args: