diff options
author | Patrick Totzke <patricktotzke@gmail.com> | 2012-09-05 21:58:12 +0100 |
---|---|---|
committer | Patrick Totzke <patricktotzke@gmail.com> | 2012-09-05 21:58:12 +0100 |
commit | 0dd720a648cd535037537973210ead00cb972110 (patch) | |
tree | df21d1a36529903638fc4225fae9d0e999db5f73 /alot/ui.py | |
parent | 61f5cdb06a6c4bc77d9f9012fa31b01fbe7d0718 (diff) |
doc: docstrings
Diffstat (limited to 'alot/ui.py')
-rw-r--r-- | alot/ui.py | 22 |
1 files changed, 18 insertions, 4 deletions
@@ -142,6 +142,13 @@ class UI(object): self.update() def apply_commandline(self, cmdline): + """ + Interprets a command line string and applies the resulting + (sequence of) :class:`Commands <alot.commands.Command>`. + + :param cmdline: command line to interpret + :type cmdline: str + """ # split commandline if necessary cmd = None cmdlist = split_commandline(cmdline) @@ -177,7 +184,10 @@ class UI(object): self._locked = True def prompt(self, prefix, text=u'', completer=None, tab=0, history=[]): - """prompt for text input + """ + prompt for text input. + This returns a :class:`~twisted.defer.Deferred` that calls back with + the input string. :param prefix: text to print before the input field :type prefix: str @@ -305,7 +315,11 @@ class UI(object): def get_buffers_of_type(self, t): """ returns currently open buffers for a given subclass of - :class:`~alot.buffers.Buffer` + :class:`~alot.buffers.Buffer`. + + :param t: Buffer class + :type t: alot.buffers.Buffer + :rtype: list """ return filter(lambda x: isinstance(x, t), self.buffers) @@ -330,7 +344,7 @@ class UI(object): def choice(self, message, choices={'y': 'yes', 'n': 'no'}, select=None, cancel=None, msg_position='above'): """ - prompt user to make a choice + prompt user to make a choice. :param message: string to display before list of choices :type message: unicode @@ -388,7 +402,7 @@ class UI(object): def notify(self, message, priority='normal', timeout=0, block=False): """ - opens notification popup + opens notification popup. :param message: message to print :type message: str |