Patchwork [07,of,18,"] verify: minimal documentation for `verifier.verify`

login
register
mail settings
Submitter Pierre-Yves David
Date March 6, 2019, 4:29 p.m.
Message ID <feeaebe5aa639ce0d8df.1551889763@nodosa.octopoid.net>
Download mbox | patch
Permalink /patch/39104/
State Accepted
Headers show

Comments

Pierre-Yves David - March 6, 2019, 4:29 p.m.
# HG changeset patch
# User Pierre-Yves David <pierre-yves.david@octobus.net>
# Date 1551868534 -3600
#      Wed Mar 06 11:35:34 2019 +0100
# Node ID feeaebe5aa639ce0d8df7e42ea2540046565aee5
# Parent  cfc34a3b69850c784cc57fbb474c1c14e0e5387e
# EXP-Topic verify
# Available At https://bitbucket.org/octobus/mercurial-devel/
#              hg pull https://bitbucket.org/octobus/mercurial-devel/ -r feeaebe5aa63
verify: minimal documentation for `verifier.verify`

I expect the docstring to grow over time, so lets start small.

Patch

diff --git a/mercurial/verify.py b/mercurial/verify.py
--- a/mercurial/verify.py
+++ b/mercurial/verify.py
@@ -130,6 +130,11 @@  class verifier(object):
         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