Commit Graph

8 Commits

Author SHA1 Message Date
Jonas Bernoulli 8a3d4c27de improve doc-strings
The first sentence should summarize the variable's or function's
purpose and it should fit on the first line.  Change existing
doc-string by:

* Move first sentence onto first line even if that makes it _a bit_
  long.
* Move additional notes out of first sentence and add them later,
  possibly as complete sentences.
* If I am uncertain whether doing the above would alter the meaning,
  _don't_ do it.
* If fitting the initial sentence on the first line would require a
  complete rewrite of the doc-string _don't_ do so unless it is very
  easy to do.
* Remove indentation from second and later lines if it is there to
  align them with the first in the source code, instead of in
  `describe-*' output.
* Make "pullet point" lists a bit more consistent.

Obviously this does not fix all problems but it's a start.
2012-11-10 14:01:17 +01:00
djcb f64922e026 * mu4e: update the mail/indexing update process:
- M-x mu4e-update-mail-and-index (C-S-U in main/headers/view/compose, with
  prefix arg, run in background
  - M-x mu4e-update-index to only update the index
  - document / add to FAQ
2012-10-25 11:59:50 +03:00
djcb 5b8de3a97b * mu4e: advertise guile support 2012-10-17 23:36:35 +03:00
djcb e342f9a5c4 * mu4e: use (user-error ..), not (error ..) for user errors 2012-09-06 10:33:53 +03:00
djcb ace830f284 * mu4e: small fix 2012-09-03 10:29:34 +03:00
djcb c8065a0e1b * mu4e: show 'C' in first line of main page to indicate crypto support 2012-09-01 20:05:17 +03:00
djcb 12226c19c0 * mu4e: make elint-clean 2012-08-14 10:20:27 +03:00
djcb dc62bd6c75 * rename emacs/ => mu4e/ 2012-07-10 20:00:06 +03:00