diff options
| author | Patrick Totzke <patricktotzke@gmail.com> | 2016-12-18 15:30:14 +0000 |
|---|---|---|
| committer | Patrick Totzke <patricktotzke@gmail.com> | 2016-12-18 15:33:50 +0000 |
| commit | 459c4b8ee2c42a0b855486484a4ebad458d53e8a (patch) | |
| tree | de051bcce19e6c54f72583327cffba519a6914ab | |
| parent | c3a6cac24393a205ba20bef012a1f942c4ed99be (diff) | |
faq
| -rw-r--r-- | README.md | 3 | ||||
| -rw-r--r-- | docs/source/faq.rst | 4 |
2 files changed, 4 insertions, 3 deletions
@@ -5,7 +5,7 @@ It is written in python using the [urwid][urwid] toolkit. [![Code Issues][quantcode-img]][quantcode] Have a look at the [user manual][docs] for installation notes, advanced usage, -customization and hacking guides. +customization, hacking guides and [frequently asked questions][FAQ]. Do comment on the code or file issues! @@ -48,6 +48,7 @@ See the [manual][docs] for more usage info. [notmuch]: http://notmuchmail.org/ [urwid]: http://excess.org/urwid/ [docs]: http://alot.rtfd.org +[FAQ]: http://alot.readthedocs.io/en/latest/faq.html [features]: https://github.com/pazz/alot/issues?labels=feature [travis]: https://travis-ci.org/pazz/alot [quantcode]: https://www.quantifiedcode.com/app/project/c5aaa4739c5b4f6eb75eaaf8c01da679 diff --git a/docs/source/faq.rst b/docs/source/faq.rst index f0836128..eeb50c07 100644 --- a/docs/source/faq.rst +++ b/docs/source/faq.rst @@ -47,7 +47,7 @@ FAQ Most `text based browsers <http://en.wikipedia.org/wiki/Text-based_web_browser>`_ have a dump mode that can be used here. -6. Why are you $THIS not $THAT way? +6. Why are you doing $THIS not $THAT way? 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 @@ -58,7 +58,7 @@ FAQ The few exceptions to above stated rule are the following: - * CLI option parsing is done using twisted.usage.Options, and not (as e.g. in-app command parsing) + * CLI option parsing is done using `twisted.usage.Options`, and not (as e.g. in-app command parsing) via argparse. The reason is that argparse does not yet offer optional subcommands. * The modules cmd and cmd2, that handle all sorts of convenience around command objects hate urwid: They are painfully strongly coupled to user in/output via stdin and out. |