Added docs

2014-07-09 16:50:17 +03:00
parent 19dd7629d3
commit d8864bdf02
1 changed files with 5 additions and 0 deletions
--- a/pygit2/repository.py
+++ b/pygit2/repository.py
@@ -301,4 +301,9 @@ class Repository(_Repository):
        raise ValueError("Only blobs and treeish can be diffed")

    def state_cleanup(self):
+        """
+        Remove all the metadata associated with an ongoing command like
+        merge, revert, cherry-pick, etc. For example: MERGE_HEAD, MERGE_MSG,
+        etc.
+        """
        C.git_repository_state_cleanup(self._repo)