transaction: document close(), abort() methods
authorGreg Ward <greg-hg@gerg.ca>
Tue, 21 Jul 2009 20:31:45 -0400
changeset 9220 8a4da1388553
parent 9219 3f650f6aa130
child 9234 65719472bfa2
transaction: document close(), abort() methods
mercurial/transaction.py
--- a/mercurial/transaction.py	Thu Jul 23 20:44:26 2009 +0200
+++ b/mercurial/transaction.py	Tue Jul 21 20:31:45 2009 -0400
@@ -118,6 +118,7 @@
 
     @active
     def close(self):
+        '''commit the transaction'''
         self.count -= 1
         if self.count != 0:
             return
@@ -131,6 +132,9 @@
 
     @active
     def abort(self):
+        '''abort the transaction (generally called on error, or when the
+        transaction is not explicitly committed before going out of
+        scope)'''
         self._abort()
 
     def _abort(self):