crecord: add docblock to handlekeypressed
authorRyan McElroy <rmcelroy@fb.com>
Fri, 18 Mar 2016 11:06:03 -0700
changeset 28581 3c8f0a605504
parent 28580 8b41ad798fb7
child 28582 cdbc25306696
crecord: add docblock to handlekeypressed This information is pretty useful when reading the code.
mercurial/crecord.py
--- a/mercurial/crecord.py	Fri Mar 18 11:06:03 2016 -0700
+++ b/mercurial/crecord.py	Fri Mar 18 11:06:03 2016 -0700
@@ -1580,6 +1580,11 @@
         return True
 
     def handlekeypressed(self, keypressed, test=False):
+        """
+        Perform actions based on pressed keys.
+
+        Return true to exit the main loop.
+        """
         if keypressed in ["k", "KEY_UP"]:
             self.uparrowevent()
         if keypressed in ["K", "KEY_PPAGE"]: