[PATCH 1/6] emacs: break up notmuch-show-archive-thread-internal into two generally useful functions

Aaron Ecay aaronecay at gmail.com
Tue Jan 17 12:57:58 PST 2012


On Tue, 17 Jan 2012 12:17:54 -0800, Jameson Graef Rollins <jrollins at finestructure.net> wrote:
> 
> We're not currently in the habit of adding doc strings for
> non-interactive programs.  Do we need to go down that route?

It is handy for developers, since the usual documentation facilities
(describe-function, apropos, ...) will then work for that function too.
Emacs documentation recommends(-ish) this:

,----[ Elisp manual Section D.6 ]
| An internal variable or subroutine of a Lisp program might as well
| have a documentation string.  In earlier Emacs versions, you could
| save space by using a comment instead of a documentation string,
| but that is no longer the case--documentation strings now take up
| very little space in a running Emacs.
`----

-- 
Aaron Ecay


More information about the notmuch mailing list