emacs: Improve doc-strings
authorJonas Bernoulli <jonas@bernoul.li>
Sat, 8 Aug 2020 11:49:50 +0000 (13:49 +0200)
committerDavid Bremner <david@tethera.net>
Mon, 10 Aug 2020 00:14:36 +0000 (21:14 -0300)
commite63f37a4a90c5d2a399a99a0566b6e1dfea263aa
tree925c23fe8cd313d5fbd77708303ebe4d3f5335a2
parentc4541353765dec837c1c2f912b1bf6661827429c
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.
emacs/notmuch-address.el
emacs/notmuch-query.el
emacs/notmuch-show.el
emacs/notmuch-tree.el
emacs/notmuch.el
emacs/rstdoc.el