summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--INSTALL.md9
-rw-r--r--alot/helper.py25
-rw-r--r--docs/source/usage/synopsis.rst2
3 files changed, 18 insertions, 18 deletions
diff --git a/INSTALL.md b/INSTALL.md
index 787855a6..32efbdf2 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -52,11 +52,10 @@ other dependencies
* a mailcap file (I recommend installing 'mime-support' on debian/ubuntu).
This is used to determine the commands to call when opening attachments
or text-rendering parts that are not plaintext, e.g. text/html.
- Make sure you have a inline renderer for text/html set as otherwise
+ Make sure you have a inline renderer for text/html set in your mailcap as otherwise
html mails will not display:
-
- #~/.mailcap, take w3m for example:
- text/html; w3m -dump %s; nametemplate=%s.html; copiousoutput
+
+ text/html; w3m -dump %s; nametemplate=%s.html; copiousoutput
All other configs are optional, but if you want to send mails you need to specify at least one
@@ -67,5 +66,3 @@ account section in your config:
address = your@address
See the [user docs][docs] for how to do fancy customization.
-
-:x
diff --git a/alot/helper.py b/alot/helper.py
index 6ab4ff1b..cd258c7a 100644
--- a/alot/helper.py
+++ b/alot/helper.py
@@ -126,17 +126,20 @@ def shorten_author_string(authors_string, maxlength):
between first and next authors is added.
- EXAMPLE (authors string with different length constrains):
- 'King Kong, Mucho Muchacho, Jaime Huerta, Flash Gordon'
- 'King, Mucho, Jaime, Flash'
- 'King, ., Jaime, Flash'
- 'King, ., J., Flash'
- 'King, ., Flash'
- 'King, ., Fl.'
- 'King, .'
- 'K., .'
- 'K.'
- """
+ >>> authors = u'King Kong, Mucho Muchacho, Jaime Huerta, Flash Gordon'
+ >>> print shorten_author_string(authors, 60)
+ King Kong, Mucho Muchacho, Jaime Huerta, Flash Gordon
+ >>> print shorten_author_string(authors, 40)
+ King, Mucho, Jaime, Flash
+ >>> print shorten_author_string(authors, 20)
+ King, …, Jai…, Flash
+ >>> print shorten_author_string(authors, 10)
+ King, …
+ >>> print shorten_author_string(authors, 2)
+ K…
+ >>> print shorten_author_string(authors, 1)
+ K
+ """
# I will create a list of authors by parsing author_string. I use
# deque to do popleft without performance penalties
diff --git a/docs/source/usage/synopsis.rst b/docs/source/usage/synopsis.rst
index f9bcf043..54a61a81 100644
--- a/docs/source/usage/synopsis.rst
+++ b/docs/source/usage/synopsis.rst
@@ -9,7 +9,7 @@ Options
-r, --read-only open db in read only mode
-c, --config=FILENAME config file (default: ~/.config/alot/config)
-n, --notmuch-config=FILENAME notmuch config (default: ~/.notmuch-config)
- -C, --colour-mode=COLOR terminal colour mode (default: 256). Must be 1, 16 or 256
+ -C, --colour-mode=COLOUR terminal colour mode (default: 256). Must be 1, 16 or 256
-p, --mailindex-path=PATH path to notmuch index
-d, --debug-level=LEVEL debug log (default: info). Must be one of debug,info,warning or error
-l, --logfile=FILENAME logfile (default: /dev/null)