From 1edb6c6dc2a0dc9b20f544c6b500e2d991a07dd7 Mon Sep 17 00:00:00 2001 From: Lucas Hoffmann Date: Sat, 17 Sep 2016 09:13:59 +0200 Subject: Remove trailing white space --- docs/source/api/commands.rst | 4 ++-- docs/source/api/database.rst | 2 +- docs/source/api/interface.rst | 4 ++-- docs/source/configuration/accounts_table | 4 ++-- docs/source/configuration/alotrc_table | 8 ++++---- docs/source/configuration/contacts_completion.rst | 2 +- docs/source/configuration/hooks.rst | 2 +- docs/source/configuration/key_bindings.rst | 2 +- docs/source/faq.rst | 4 ++-- docs/source/index.rst | 2 +- docs/source/usage/modes/global.rst | 4 +--- docs/source/usage/modes/search.rst | 1 - 12 files changed, 18 insertions(+), 21 deletions(-) (limited to 'docs') diff --git a/docs/source/api/commands.rst b/docs/source/api/commands.rst index cb1a9d7f..cae10a03 100644 --- a/docs/source/api/commands.rst +++ b/docs/source/api/commands.rst @@ -10,7 +10,7 @@ Command-line strings given by the user via the prompt or key bindings can be tra Specific actions are defined as subclasses of :class:`Command` and can be registered to a global command pool using the :class:`registerCommand` decorator. -.. Note:: +.. Note:: that the return value of :func:`commandfactory` depends on the current *mode* the user interface is in. @@ -34,7 +34,7 @@ to a global command pool using the :class:`registerCommand` decorator. .. autoclass:: Command :members: - + .. autoclass:: CommandParseError .. autoclass:: CommandArgumentParser .. autofunction:: commandfactory diff --git a/docs/source/api/database.rst b/docs/source/api/database.rst index ff66fd3e..bead2609 100644 --- a/docs/source/api/database.rst +++ b/docs/source/api/database.rst @@ -3,7 +3,7 @@ Email Database .. module:: alot.db -The python bindings to libnotmuch define :class:`notmuch.Thread` and +The python bindings to libnotmuch define :class:`notmuch.Thread` and :class:`notmuch.Message`, which unfortunately are very fragile. Alot defines the wrapper classes :class:`alot.db.Thread` and :class:`alot.db.Message` that use an :class:`manager.DBManager` instance to transparently provide persistent objects. diff --git a/docs/source/api/interface.rst b/docs/source/api/interface.rst index 27ed06d5..39b9cd3c 100644 --- a/docs/source/api/interface.rst +++ b/docs/source/api/interface.rst @@ -27,7 +27,7 @@ input and acts on it: .. code-block:: python from twisted.internet import defer - + @defer.inlineCallbacks def greet(ui): # ui is instance of alot.ui.UI name = yield ui.prompt('pls enter your name') @@ -102,7 +102,7 @@ Completion :meth:`alot.ui.UI.prompt` allows tab completion using a :class:`~alot.completion.Completer` object handed as 'completer' parameter. :mod:`alot.completion` defines several subclasses for different occasions like completing email addresses from an -:class:`~alot.account.AddressBook`, notmuch tagstrings. Some of these actually build on top +:class:`~alot.account.AddressBook`, notmuch tagstrings. Some of these actually build on top of each other; the :class:`~alot.completion.QueryCompleter` for example uses a :class:`~alot.completion.TagsCompleter` internally to allow tagstring completion after "is:" or "tag:" keywords when typing a notmuch querystring. diff --git a/docs/source/configuration/accounts_table b/docs/source/configuration/accounts_table index e267ff9b..cc3e5646 100644 --- a/docs/source/configuration/accounts_table +++ b/docs/source/configuration/accounts_table @@ -47,7 +47,7 @@ where to store outgoing mails, e.g. `maildir:///home/you/mail/Sent`. You can use mbox, maildir, mh, babyl and mmdf in the protocol part of the URL. - + .. note:: If you want to add outgoing mails automatically to the notmuch index you must use maildir in a path within your notmuch database path. @@ -61,7 +61,7 @@ where to store draft mails, e.g. `maildir:///home/you/mail/Drafts`. You can use mbox, maildir, mh, babyl and mmdf in the protocol part of the URL. - + .. note:: You will most likely want drafts indexed by notmuch to be able to later access them within alot. This currently only works for maildir containers in a path below your notmuch database path. diff --git a/docs/source/configuration/alotrc_table b/docs/source/configuration/alotrc_table index 4125e7fc..e1a4fa73 100644 --- a/docs/source/configuration/alotrc_table +++ b/docs/source/configuration/alotrc_table @@ -82,7 +82,7 @@ Format of the status-bar in bufferlist mode. This is a pair of strings to be left and right aligned in the status-bar that may contain variables: - + * `{buffer_no}`: index of this buffer in the global buffer list * `{total_messages}`: total numer of messages indexed by notmuch * `{pending_writes}`: number of pending write operations to the index @@ -227,7 +227,7 @@ This is a pair of strings to be left and right aligned in the status-bar. Apart from the global variables listed at :ref:`bufferlist_statusbar ` these strings may contain variables: - + * `{to}`: To-header of the envelope :type: mixed_list @@ -444,7 +444,7 @@ This is a pair of strings to be left and right aligned in the status-bar. Apart from the global variables listed at :ref:`bufferlist_statusbar ` these strings may contain variables: - + * `{querystring}`: search string * `{result_count}`: number of matching messages * `{result_count_positive}`: 's' if result count is greater than 0. @@ -578,7 +578,7 @@ This is a pair of strings to be left and right aligned in the status-bar. Apart from the global variables listed at :ref:`bufferlist_statusbar ` these strings may contain variables: - + * `{tid}`: thread id * `{subject}`: subject line of the thread * `{authors}`: abbreviated authors string for this thread diff --git a/docs/source/configuration/contacts_completion.rst b/docs/source/configuration/contacts_completion.rst index 51fae0d7..707af984 100644 --- a/docs/source/configuration/contacts_completion.rst +++ b/docs/source/configuration/contacts_completion.rst @@ -55,7 +55,7 @@ Both respect the `ignorecase` option which defaults to `True` and results in cas command = notmuch_abook.py lookup regexp = ^((?P[^(\\s+\<)]*)\s+<)?(?P[^@]+?@[^>]+)>?$ - + `notmuch address` Since version `0.19`, notmuch itself offers a subcommand `address`, that returns email addresses found in the notmuch index. diff --git a/docs/source/configuration/hooks.rst b/docs/source/configuration/hooks.rst index a384d73e..7577e87a 100644 --- a/docs/source/configuration/hooks.rst +++ b/docs/source/configuration/hooks.rst @@ -184,7 +184,7 @@ Apart from command pre- and posthooks, the following hooks will be interpreted: returns `prefix` and `suffix` for a sanitized filename to use while opening an attachment. The `prefix` and `suffix` are used to open a file named - `prefix` + `XXXXXX` + `suffix` in a temporary directory. + `prefix` + `XXXXXX` + `suffix` in a temporary directory. :param filename: filename provided in the email (can be None) :type filename: str or None diff --git a/docs/source/configuration/key_bindings.rst b/docs/source/configuration/key_bindings.rst index ea8f9358..fe8da87f 100644 --- a/docs/source/configuration/key_bindings.rst +++ b/docs/source/configuration/key_bindings.rst @@ -31,7 +31,7 @@ Have a look at `the urwid User Input documentation `_ if you don't want/have the time/know how to implement it yourself. Be verbose as to how it should look or work when it's finished and give it some thought how you think we should implement it. We'll discuss it from there. @@ -51,7 +51,7 @@ FAQ Lazyness and Ignorance: In most cases I simply did not or still don't know a better solution. I try to outsource as much as I can to well established libraries and be it only to avoid - having to read rfc's. But there are lots + having to read rfc's. But there are lots of tasks I implemented myself, possibly overlooking a ready made and available solution. Twisted is such a feature-rich but gray area in my mind for example. If you think you know how to improve the current implementation let me know! diff --git a/docs/source/index.rst b/docs/source/index.rst index d383dad5..37d7c137 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -10,7 +10,7 @@ User Manual .. toctree:: :maxdepth: 2 :numbered: - + installation usage/index configuration/index diff --git a/docs/source/usage/modes/global.rst b/docs/source/usage/modes/global.rst index 8099500e..90d61f35 100644 --- a/docs/source/usage/modes/global.rst +++ b/docs/source/usage/modes/global.rst @@ -55,10 +55,8 @@ The following commands are available globally .. describe:: help - display help for a command. Use 'bindings' to display all keybings interpreted in current mode.' - argument command or 'bindings' @@ -154,7 +152,7 @@ The following commands are available globally .. describe:: call - Executes python code + Executes python code argument python command string to call diff --git a/docs/source/usage/modes/search.rst b/docs/source/usage/modes/search.rst index 76646a4e..20e22b44 100644 --- a/docs/source/usage/modes/search.rst +++ b/docs/source/usage/modes/search.rst @@ -98,7 +98,6 @@ The following commands are available in search mode A tag is considered present if at least one message contained in this thread is tagged with it. In that case this command will remove the tag from every message in the thread. - argument comma separated list of tags -- cgit v1.2.3