# HG changeset patch
# User Pierre-Yves David <pierre-yves.david@octobus.net>
# Date 1551877823 -3600
# Node ID 08d977451f2673f4d5b18f21cdb6451aa6d692fb
# Parent  3f3f962457b20f9570e0b676a83ccc984ed27125
verify: document the `checklog` method

Let us add details about what the function is expected to do.

diff -r 3f3f962457b2 -r 08d977451f26 mercurial/verify.py
--- a/mercurial/verify.py	Wed Mar 06 14:07:27 2019 +0100
+++ b/mercurial/verify.py	Wed Mar 06 14:10:23 2019 +0100
@@ -77,6 +77,13 @@
         self._err(linkrev, "%s: %s" % (msg, fmsg), filename)
 
     def checklog(self, obj, name, linkrev):
+        """verify high level property of a revlog
+
+        - revlog is present,
+        - revlog is non-empty,
+        - sizes (index and data) are correct,
+        - revlog's format version is correct.
+        """
         if not len(obj) and (self.havecl or self.havemf):
             self._err(linkrev, _("empty or missing %s") % name)
             return