[PATCH 3 of 5] crecord: add docblock to handlekeypressed

Ryan McElroy rm at fb.com
Fri Mar 18 14:18:46 EDT 2016


# HG changeset patch
# User Ryan McElroy <rmcelroy at fb.com>
# Date 1458324363 25200
#      Fri Mar 18 11:06:03 2016 -0700
# Node ID d8070a9639933f2c37552f865288fb070cf816e8
# Parent  597500be7cef33768ebcf933c303d7ace922e575
crecord: add docblock to handlekeypressed

This information is pretty useful when reading the code.

diff --git a/mercurial/crecord.py b/mercurial/crecord.py
--- a/mercurial/crecord.py
+++ b/mercurial/crecord.py
@@ -1580,6 +1580,11 @@ are you sure you want to review/edit and
         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"]:


More information about the Mercurial-devel mailing list