notmuch/emacs
Jonas Bernoulli e63f37a4a9 emacs: Improve doc-strings
- The first sentence should fit on the first line in full.  This is
  even the case when that causes the line to get a bit long.  If it
  gets very long, then it should be made shorter.

- Even even the second sentence would fit on the first line, if it
  just provides some details, then it shouldn't be done.

- Symbols are quoted like `so'.

- There is no clear rule on how to (not) quote non-atomic
  s-expressions, but quoting like '(this) is definitely weird.

- It is a good idea to remember that \" becomes " and to take
  that in mind when adjusting the automatic filling by hand.

- Use the imperative form.

- Arguments are written in all uppercase.
2020-08-09 21:14:36 -03:00
..
.gitignore emacs: build docstring (rsti) files 2018-12-08 08:49:31 -04:00
coolj.el emacs: Use 'and' instead of 'when' when the return value matters 2020-08-09 20:51:16 -03:00
make-deps.el emacs: Remove excess empty lines 2020-08-09 20:47:52 -03:00
Makefile fix sum moar typos [build scripts, Makefiles] 2011-06-23 15:44:59 -07:00
Makefile.local emacs: Use makefile-gmake-mode in Makefile*s 2020-08-09 21:14:36 -03:00
notmuch-address.el emacs: Improve doc-strings 2020-08-09 21:14:36 -03:00
notmuch-company.el emacs: Shorten long lines 2020-08-09 19:48:36 -03:00
notmuch-compat.el emacs: Use 'when' instead of 'if' when there is no ELSE part 2020-08-09 20:52:34 -03:00
notmuch-crypto.el emacs: Use 'and' instead of 'when' when the return value matters 2020-08-09 20:51:16 -03:00
notmuch-draft.el emacs: Use 'and' instead of 'when' when the return value matters 2020-08-09 20:51:16 -03:00
notmuch-emacs-mua notmuch-emacs-mua: add --hello parameter 2016-11-26 08:15:11 -04:00
notmuch-emacs-mua.desktop emacs: add keywords to notmuch-emacs-mua.desktop 2019-06-29 21:06:18 +02:00
notmuch-hello.el emacs: No longer define notmuch-hello-mode-map as a function 2020-08-09 20:58:05 -03:00
notmuch-jump.el emacs: Use 'when' instead of 'if' when there is no ELSE part 2020-08-09 20:52:34 -03:00
notmuch-lib.el emacs: notmuch-poll: Let the user know we are polling 2020-08-09 20:59:11 -03:00
notmuch-logo.png emacs: Add notmuch-hello.el, a friendly frontend to notmuch 2010-04-23 12:50:18 -07:00
notmuch-maildir-fcc.el emacs: Use 'and' instead of 'when' when the return value matters 2020-08-09 20:51:16 -03:00
notmuch-message.el emacs: Shorten long lines 2020-08-09 19:48:36 -03:00
notmuch-mua.el emacs: Use 'when' instead of 'if' when there is no ELSE part 2020-08-09 20:52:34 -03:00
notmuch-parser.el emacs: Use 'unless' instead of 'when' and 'not' 2020-08-09 20:51:26 -03:00
notmuch-pkg.el.tmpl emacs: Use cl-lib' instead of deprecated cl' 2020-04-27 07:36:10 -03:00
notmuch-print.el emacs: use ".ps" suffix for PostScript temporary files. 2019-01-30 07:15:59 -04:00
notmuch-query.el emacs: Improve doc-strings 2020-08-09 21:14:36 -03:00
notmuch-show.el emacs: Improve doc-strings 2020-08-09 21:14:36 -03:00
notmuch-tag.el emacs: Fix some function declarations 2020-08-09 20:57:51 -03:00
notmuch-tree.el emacs: Improve doc-strings 2020-08-09 21:14:36 -03:00
notmuch-version.el.tmpl Use https instead of http where possible 2016-06-05 08:32:17 -03:00
notmuch-wash.el emacs: Use 'when' instead of 'if' when there is no ELSE part 2020-08-09 20:52:34 -03:00
notmuch.el emacs: Improve doc-strings 2020-08-09 21:14:36 -03:00
rstdoc.el emacs: Improve doc-strings 2020-08-09 21:14:36 -03:00
rstdoc.rsti emacs: initial version of rstdoc.el 2018-12-08 08:45:48 -04:00