Przeglądaj źródła

Fix pydoctor issues

Jelmer Vernooij 5 miesięcy temu
rodzic
commit
268e6b0884
4 zmienionych plików z 16 dodań i 19 usunięć
  1. 2 2
      dulwich/client.py
  2. 0 1
      dulwich/dumb.py
  3. 12 12
      dulwich/repo.py
  4. 2 4
      dulwich/server.py

+ 2 - 2
dulwich/client.py

@@ -1688,13 +1688,13 @@ class TCPGitClient(TraditionalGitClient):
         return cls(parsedurl.hostname, port=parsedurl.port, **kwargs)
         return cls(parsedurl.hostname, port=parsedurl.port, **kwargs)
 
 
     def get_url(self, path):
     def get_url(self, path):
-        """Get the URL for a TCP git connection.
+        r"""Get the URL for a TCP git connection.
 
 
         Args:
         Args:
           path: Repository path
           path: Repository path
 
 
         Returns:
         Returns:
-          git:// URL for the path
+          ``git://`` URL for the path
         """
         """
         netloc = self._host
         netloc = self._host
         if self._port is not None and self._port != TCP_GIT_PORT:
         if self._port is not None and self._port != TCP_GIT_PORT:

+ 0 - 1
dulwich/dumb.py

@@ -451,7 +451,6 @@ class DumbRemoteHTTPRepo:
           determine_wants: Function that returns list of wanted SHAs
           determine_wants: Function that returns list of wanted SHAs
           progress: Optional progress callback
           progress: Optional progress callback
           get_tagged: Whether to get tagged objects
           get_tagged: Whether to get tagged objects
-          depth: Shallow clone depth
           depth: Depth for shallow clones (not supported for dumb HTTP)
           depth: Depth for shallow clones (not supported for dumb HTTP)
 
 
         Returns:
         Returns:

+ 12 - 12
dulwich/repo.py

@@ -902,24 +902,24 @@ class BaseRepo:
           include: Iterable of SHAs of commits to include along with their
           include: Iterable of SHAs of commits to include along with their
             ancestors. Defaults to [HEAD]
             ancestors. Defaults to [HEAD]
           **kwargs: Additional keyword arguments including:
           **kwargs: Additional keyword arguments including:
-            exclude: Iterable of SHAs of commits to exclude along with their
+
+            * exclude: Iterable of SHAs of commits to exclude along with their
               ancestors, overriding includes.
               ancestors, overriding includes.
-            order: ORDER_* constant specifying the order of results.
+            * order: ORDER_* constant specifying the order of results.
               Anything other than ORDER_DATE may result in O(n) memory usage.
               Anything other than ORDER_DATE may result in O(n) memory usage.
-            reverse: If True, reverse the order of output, requiring O(n)
+            * reverse: If True, reverse the order of output, requiring O(n)
               memory.
               memory.
-            max_entries: The maximum number of entries to yield, or None for
+            * max_entries: The maximum number of entries to yield, or None for
               no limit.
               no limit.
-            paths: Iterable of file or subtree paths to show entries for.
-            rename_detector: diff.RenameDetector object for detecting
+            * paths: Iterable of file or subtree paths to show entries for.
+            * rename_detector: diff.RenameDetector object for detecting
               renames.
               renames.
-            follow: If True, follow path across renames/copies. Forces a
+            * follow: If True, follow path across renames/copies. Forces a
               default rename_detector.
               default rename_detector.
-            since: Timestamp to list commits after.
-            until: Timestamp to list commits before.
-            queue_cls: A class to use for a queue of commits, supporting the
-              iterator protocol. The constructor takes a single argument, the
-            Walker.
+            * since: Timestamp to list commits after.
+            * until: Timestamp to list commits before.
+            * queue_cls: A class to use for a queue of commits, supporting the
+              iterator protocol. The constructor takes a single argument, the Walker.
 
 
         Returns: A `Walker` object
         Returns: A `Walker` object
         """
         """

+ 2 - 4
dulwich/server.py

@@ -685,16 +685,14 @@ class _ProtocolGraphWalker:
 
 
         If the client has the 'shallow' capability, this method also reads and
         If the client has the 'shallow' capability, this method also reads and
         responds to the 'shallow' and 'deepen' lines from the client. These are
         responds to the 'shallow' and 'deepen' lines from the client. These are
-
-        Args:
-          heads: Dictionary of heads to advertise
-          depth: Maximum depth for shallow clones
         not part of the wants per se, but they set up necessary state for
         not part of the wants per se, but they set up necessary state for
         walking the graph. Additionally, later code depends on this method
         walking the graph. Additionally, later code depends on this method
         consuming everything up to the first 'have' line.
         consuming everything up to the first 'have' line.
 
 
         Args:
         Args:
           heads: a dict of refname->SHA1 to advertise
           heads: a dict of refname->SHA1 to advertise
+          depth: Maximum depth for shallow clones
+
         Returns: a list of SHA1s requested by the client
         Returns: a list of SHA1s requested by the client
         """
         """
         symrefs = self.get_symrefs()
         symrefs = self.get_symrefs()