verify: minimal documentation for `verifier.verify`
authorPierre-Yves David <pierre-yves.david@octobus.net>
Wed, 06 Mar 2019 11:35:34 +0100
changeset 41867 e8c4a9f5b986
parent 41866 cfe08588d711
child 41868 567892b4306c
verify: minimal documentation for `verifier.verify` I expect the docstring to grow over time, so lets start small.
mercurial/verify.py
--- a/mercurial/verify.py	Wed Mar 06 11:31:48 2019 +0100
+++ b/mercurial/verify.py	Wed Mar 06 11:35:34 2019 +0100
@@ -130,6 +130,11 @@
         return lr
 
     def verify(self):
+        """verify the content of the Mercurial repository
+
+        This method run all verifications, displaying issues as they are found.
+
+        return 1 if any error have been encountered"""
         repo = self.repo
 
         ui = repo.ui