From: Aaron Ecay <aaronecay@gmail.com>
To: Jameson Graef Rollins <jrollins@finestructure.net>,
	Notmuch Mail <notmuch@notmuchmail.org>
Subject: Re: [PATCH 1/6] emacs: break up notmuch-show-archive-thread-internal
	into two generally useful functions
In-Reply-To: <87sjjeytfx.fsf@servo.finestructure.net>
References: <871uqy19yo.fsf@servo.finestructure.net>
	<1326823531-14549-1-git-send-email-jrollins@finestructure.net>
	<m2d3aiay4f.fsf@gmail.com> <87sjjeytfx.fsf@servo.finestructure.net>
User-Agent: Notmuch/0.11+62~ge41b0d3 (http://notmuchmail.org) Emacs/24.0.92.1
	(i386-apple-darwin10.8.0)
Date: Tue, 17 Jan 2012 15:57:58 -0500
Message-ID: <m2vcoa9hd5.fsf@gmail.com>
MIME-Version: 1.0
Content-Type: text/plain
Precedence: list

On Tue, 17 Jan 2012 12:17:54 -0800, Jameson Graef Rollins <jrollins@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