Document Repo.path. Fixes #854

jelmer · Mar 20, 2022 · 97268af · 97268af
1 parent 346fa89
commit 97268af
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/NEWS b/NEWS
@@ -1,5 +1,8 @@
 0.20.35	UNRELEASED
 
+ * Document the ``path`` attribute for ``Repo``.
+   (Jelmer Vernooĳ, #854)
+
 0.20.34	2022-03-14
 
  * Add support for multivars in configuration.

diff --git a/dulwich/repo.py b/dulwich/repo.py
@@ -1049,6 +1049,12 @@ class Repo(BaseRepo):
     Note that a repository object may hold on to resources such
     as file handles for performance reasons; call .close() to free
     up those resources.
+
+    Attributes:
+
+      path (str): Path to the working copy (if it exists) or repository control
+        directory (if the repository is bare)
+      bare (bool): Whether this is a bare repository
     """
 
     def __init__(self, root, object_store=None, bare=None):
@@ -1175,8 +1181,8 @@ def commondir(self):
         For a main working tree, it is identical to controldir().
 
         For a linked working tree, it is the control directory of the
-        main working tree."""
-
+        main working tree.
+        """
         return self._commondir
 
     def _determine_file_mode(self):