changeset 14292:c97d8485b5fa

revlog: add docstring to _addrevision
author Sune Foldager <cryo@cyanite.org>
date Wed, 11 May 2011 11:04:44 +0200
parents 1a791993ce59
children 9adbb5ef0964
files mercurial/revlog.py
diffstat 1 files changed, 6 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/mercurial/revlog.py	Tue May 10 16:08:47 2011 -0500
+++ b/mercurial/revlog.py	Wed May 11 11:04:44 2011 +0200
@@ -978,7 +978,13 @@
 
     def _addrevision(self, node, text, transaction, link, p1, p2,
                      cachedelta, ifh, dfh):
+        """internal function to add revisions to the log
 
+        see addrevision for argument descriptions.
+        invariants:
+        - text is optional (can be None); if not set, cachedelta must be set.
+          if both are set, they must correspond to eachother.
+        """
         btext = [text]
         def buildtext():
             if btext[0] is not None: