[tor-commits] [nyx/master] Missing params from str_input() pydocs

atagar at torproject.org atagar at torproject.org
Sun Jul 31 23:32:40 UTC 2016


commit e45856eec94f059197a59cb5f7d1c196aea5db92
Author: Damian Johnson <atagar at torproject.org>
Date:   Tue Jul 19 09:48:36 2016 -0700

    Missing params from str_input() pydocs
    
    Added a couple new parameters but weren't documented. Also, these functions
    don't care that Stem has an autocompletion module - all it cares about is that
    it takes a function that suggests tab completion results. It can be provided
    with other functions too.
---
 nyx/curses.py | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/nyx/curses.py b/nyx/curses.py
index a6a8b2d..004a480 100644
--- a/nyx/curses.py
+++ b/nyx/curses.py
@@ -261,6 +261,8 @@ def str_input(x, y, initial_text = '', backlog = None, tab_completion = None):
   :param int x: horizontal location
   :param int y: vertical location
   :param str initial_text: initial input of the field
+  :param list backlog: previous inputs that can be selected by pressing up/down
+  :param func tab_completion: function to suggest inputs to tab complete with
 
   :returns: **str** with the user input or **None** if the prompt is canceled
   """
@@ -384,8 +386,7 @@ def _handle_tab_completion(next_handler, tab_completion, textbox, key):
   contents are checked for probable commands.
 
   :param func next_handler: handler to invoke after this
-  :param Autocompleter.matches tab_completion: function to suggest probable
-    commands based on current content
+  :param func tab_completion: function to suggest inputs to tab complete with
   :param Textbox textbox: current textbox context
   :param int key: key pressed
 





More information about the tor-commits mailing list