2
0
Jelmer Vernooij 13 жил өмнө
parent
commit
eae3606c6a
1 өөрчлөгдсөн 27 нэмэгдсэн , 7 устгасан
  1. 27 7
      dulwich/repo.py

+ 27 - 7
dulwich/repo.py

@@ -850,8 +850,8 @@ class BaseRepo(object):
     def open_index(self):
         """Open the index for this repository.
 
-        :raises NoIndexPresent: If no index is present
-        :return: Index instance
+        :raise NoIndexPresent: If no index is present
+        :return: The matching `Index`
         """
         raise NotImplementedError(self.open_index)
 
@@ -909,11 +909,19 @@ class BaseRepo(object):
         return self.object_store.get_graph_walker(heads)
 
     def ref(self, name):
-        """Return the SHA1 a ref is pointing to."""
+        """Return the SHA1 a ref is pointing to.
+
+        :param name: Name of the ref to look up
+        :raise KeyError: when the ref (or the one it points to) does not exist
+        :return: SHA1 it is pointing at
+        """
         return self.refs[name]
 
     def get_refs(self):
-        """Get dictionary with all refs."""
+        """Get dictionary with all refs.
+
+        :return: A `dict` mapping ref names to SHA1s
+        """
         return self.refs.as_dict()
 
     def head(self):
@@ -1067,6 +1075,7 @@ class BaseRepo(object):
         :param queue_cls: A class to use for a queue of commits, supporting the
             iterator protocol. The constructor takes a single argument, the
             Walker.
+        :return: A `Walker` object
         """
         from dulwich.walk import Walker
         if include is None:
@@ -1141,6 +1150,8 @@ class BaseRepo(object):
             raise ValueError(name)
 
     def _get_user_identity(self):
+        """Determine the identity to use for new commits.
+        """
         config = self.get_config_stack()
         return "%s <%s>" % (
             config.get(("user", ), "name"),
@@ -1289,7 +1300,11 @@ class Repo(BaseRepo):
         return os.path.join(self.controldir(), INDEX_FILENAME)
 
     def open_index(self):
-        """Open the index for this repository."""
+        """Open the index for this repository.
+
+        :raise NoIndexPresent: If no index is present
+        :return: The matching `Index`
+        """
         from dulwich.index import Index
         if not self.has_index():
             raise NoIndexPresent()
@@ -1338,7 +1353,9 @@ class Repo(BaseRepo):
         :param target_path: Target path
         :param mkdir: Create the target directory
         :param bare: Whether to create a bare repository
-        :return: Created repository
+        :param origin: Base name for refs in target repository
+            cloned from this repository
+        :return: Created repository as `Repo`
         """
         if not bare:
             target = self.init(target_path, mkdir=mkdir)
@@ -1435,7 +1452,10 @@ class MemoryRepo(BaseRepo):
         return StringIO(contents)
 
     def open_index(self):
-        """Fail to open index for this repo, since it is bare."""
+        """Fail to open index for this repo, since it is bare.
+
+        :raise NoIndexPresent: Raised when no index is present
+        """
         raise NoIndexPresent()
 
     @classmethod