Fixed #13: Remapped docs from F1 to F9.

saws/keys.py

@@ -76,18 +76,6 @@ def create_key_manager(self, set_color, get_color,
         assert callable(handle_docs)
         self.manager = KeyBindingManager(enable_system_bindings=True)
 
-        @self.manager.registry.add_binding(Keys.F1)
-        def handle_f1(_):
-            """Inputs the "docs" command when the `F1` key is pressed.
-
-            Args:
-                * _: An instance of prompt_toolkit's Event (not used).
-
-            Returns:
-                None.
-            """
-            handle_docs(from_fkey=True)
-
         @self.manager.registry.add_binding(Keys.F2)
         def handle_f2(_):
             """Enables/Disables color output.
@@ -136,6 +124,18 @@ def handle_f5(_):
             """
             refresh_resources()
 
+        @self.manager.registry.add_binding(Keys.F9)
+        def handle_f9(_):
+            """Inputs the "docs" command when the `F9` key is pressed.
+
+            Args:
+                * _: An instance of prompt_toolkit's Event (not used).
+
+            Returns:
+                None.
+            """
+            handle_docs(from_fkey=True)
+
         @self.manager.registry.add_binding(Keys.F10)
         def handle_f10(_):
             """Quits when the `F10` key is pressed.

saws/saws.py

@@ -215,7 +215,7 @@ def refresh_resources(self):
         self.completer.refresh_resources(force_refresh=True)
 
     def handle_docs(self, text=None, from_fkey=False):
-        """Displays contextual web docs for `F1` or the `docs` command.
+        """Displays contextual web docs for `F9` or the `docs` command.
 
         Displays the web docs specific to the currently entered:
 
@@ -232,7 +232,7 @@ def handle_docs(self, text=None, from_fkey=False):
         Args:
             * text: A string representing the input command text.
             * from_fkey: A boolean representing whether this function is
-                being executed from an `F1` key press.
+                being executed from an `F9` key press.
 
         Returns:
             A boolean representing whether the web docs were shown.
@@ -241,7 +241,7 @@ def handle_docs(self, text=None, from_fkey=False):
         index_html = 'index.html'
         if text is None:
             text = self.aws_cli.current_buffer.document.text
-        # If the user hit the F1 key, append 'docs' to the text
+        # If the user hit the F9 key, append 'docs' to the text
         if from_fkey:
             text = text.strip() + ' ' + AwsCommands.AWS_DOCS
         tokens = text.split()
@@ -262,7 +262,7 @@ def handle_docs(self, text=None, from_fkey=False):
                 return True
             webbrowser.open(base_url + index_html)
         # If we still haven't opened the help doc at this point and the
-        # user hit the F1 key or typed docs, just open the main docs index
+        # user hit the F9 key or typed docs, just open the main docs index
         if from_fkey or AwsCommands.AWS_DOCS in tokens:
             webbrowser.open(base_url + index_html)
             return True

saws/toolbar.py

@@ -83,11 +83,11 @@ def get_toolbar_items(_):
                 shortcuts_token = Token.Toolbar.Off
                 shortcuts = 'OFF'
             return [
-                (Token.Toolbar, ' [F1] Docs '),
                 (color_token, ' [F2] Color: {0} '.format(color)),
                 (fuzzy_token, ' [F3] Fuzzy: {0} '.format(fuzzy)),
                 (shortcuts_token, ' [F4] Shortcuts: {0} '.format(shortcuts)),
                 (Token.Toolbar, ' [F5] Refresh '),
+                (Token.Toolbar, ' [F9] Docs '),
                 (Token.Toolbar, ' [F10] Exit ')
             ]
 

tests/test_keys.py

@@ -39,11 +39,6 @@ def setUp(self, mock_print):
         self.processor = self.saws.aws_cli.input_processor
         self.DOCS_HOME_URL = 'http://docs.aws.amazon.com/cli/latest/reference/index.html'
 
-    @mock.patch('saws.saws.webbrowser')
-    def test_F1(self, mock_webbrowser):
-        self.processor.feed_key(KeyPress(Keys.F1, ''))
-        mock_webbrowser.open.assert_called_with(self.DOCS_HOME_URL)
-
     def test_F2(self):
         orig_color = self.saws.get_color()
         self.processor.feed_key(KeyPress(Keys.F2, ''))
@@ -59,6 +54,11 @@ def test_F4(self):
         self.processor.feed_key(KeyPress(Keys.F4, ''))
         assert orig_shortcut != self.saws.get_shortcut_match()
 
+    @mock.patch('saws.saws.webbrowser')
+    def test_F9(self, mock_webbrowser):
+        self.processor.feed_key(KeyPress(Keys.F9, ''))
+        mock_webbrowser.open.assert_called_with(self.DOCS_HOME_URL)
+
     def test_F10(self):
         with self.assertRaises(EOFError):
             self.processor.feed_key(KeyPress(Keys.F10, ''))

tests/test_toolbar.py

@@ -34,11 +34,11 @@ def setUp(self, mock_print):
 
     def test_toolbar_on(self):
         expected = [
-            (Token.Toolbar, ' [F1] Docs '),
             (Token.Toolbar.On, ' [F2] Color: ON '),
             (Token.Toolbar.On, ' [F3] Fuzzy: ON '),
             (Token.Toolbar.On, ' [F4] Shortcuts: ON '),
             (Token.Toolbar, ' [F5] Refresh '),
+            (Token.Toolbar, ' [F9] Docs '),
             (Token.Toolbar, ' [F10] Exit ')]
         assert expected == self.toolbar.handler(None)
 
@@ -47,10 +47,10 @@ def test_toolbar_off(self):
         self.saws.set_fuzzy_match(False)
         self.saws.set_shortcut_match(False)
         expected = [
-            (Token.Toolbar, ' [F1] Docs '),
             (Token.Toolbar.Off, ' [F2] Color: OFF '),
             (Token.Toolbar.Off, ' [F3] Fuzzy: OFF '),
             (Token.Toolbar.Off, ' [F4] Shortcuts: OFF '),
             (Token.Toolbar, ' [F5] Refresh '),
+            (Token.Toolbar, ' [F9] Docs '),
             (Token.Toolbar, ' [F10] Exit ')]
         assert expected == self.toolbar.handler(None)