mu/mu4e
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
..
Makefile.am * mu4e: add mu4e-draft.el to Makefile.am 2012-10-31 20:35:05 +02:00
TODO * rename emacs/ => mu4e/ 2012-07-10 20:00:06 +03:00
fdl.texi * fix guile / mu4e doc building 2012-10-20 15:49:53 +03:00
mu4e-about.org * mu4e: make sure the about-page is unfolded 2012-07-11 11:46:03 +03:00
mu4e-actions.el improve doc-strings 2012-11-10 14:01:17 +01:00
mu4e-compose.el improve doc-strings 2012-11-10 14:01:17 +01:00
mu4e-draft.el improve doc-strings 2012-11-10 14:01:17 +01:00
mu4e-headers.el improve doc-strings 2012-11-10 14:01:17 +01:00
mu4e-main.el improve doc-strings 2012-11-10 14:01:17 +01:00
mu4e-mark.el improve doc-strings 2012-11-10 14:01:17 +01:00
mu4e-message.el improve doc-strings 2012-11-10 14:01:17 +01:00
mu4e-meta.el.in * rename emacs/ => mu4e/ 2012-07-10 20:00:06 +03:00
mu4e-proc.el improve doc-strings 2012-11-10 14:01:17 +01:00
mu4e-speedbar.el * mu4e: clean up FSF address, thanks to Maciek Borzecki 2012-10-21 16:04:19 +03:00
mu4e-utils.el improve doc-strings 2012-11-10 14:01:17 +01:00
mu4e-vars.el improve doc-strings 2012-11-10 14:01:17 +01:00
mu4e-view.el improve doc-strings 2012-11-10 14:01:17 +01:00
mu4e.el improve doc-strings 2012-11-10 14:01:17 +01:00
mu4e.org * rename emacs/ => mu4e/ 2012-07-10 20:00:06 +03:00
mu4e.texi * minor 2012-11-04 20:41:56 +02:00
org-mu4e.el improve doc-strings 2012-11-10 14:01:17 +01:00
texi.texi.in * fix guile / mu4e doc building 2012-10-20 15:49:53 +03:00