1 Return-Path: <aaronecay@gmail.com>
\r
2 X-Original-To: notmuch@notmuchmail.org
\r
3 Delivered-To: notmuch@notmuchmail.org
\r
4 Received: from localhost (localhost [127.0.0.1])
\r
5 by olra.theworths.org (Postfix) with ESMTP id E0E36421197
\r
6 for <notmuch@notmuchmail.org>; Tue, 17 Jan 2012 12:58:01 -0800 (PST)
\r
7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org
\r
11 X-Spam-Status: No, score=-0.799 tagged_above=-999 required=5
\r
12 tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1,
\r
13 FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled
\r
14 Received: from olra.theworths.org ([127.0.0.1])
\r
15 by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)
\r
16 with ESMTP id 3XIWe-lrAy+f for <notmuch@notmuchmail.org>;
\r
17 Tue, 17 Jan 2012 12:58:01 -0800 (PST)
\r
18 Received: from mail-qy0-f181.google.com (mail-qy0-f181.google.com
\r
19 [209.85.216.181]) (using TLSv1 with cipher RC4-SHA (128/128 bits))
\r
20 (No client certificate requested)
\r
21 by olra.theworths.org (Postfix) with ESMTPS id 5AB68429E5F
\r
22 for <notmuch@notmuchmail.org>; Tue, 17 Jan 2012 12:58:01 -0800 (PST)
\r
23 Received: by qcqw6 with SMTP id w6so2967788qcq.26
\r
24 for <notmuch@notmuchmail.org>; Tue, 17 Jan 2012 12:58:00 -0800 (PST)
\r
25 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma;
\r
26 h=from:to:subject:in-reply-to:references:user-agent:date:message-id
\r
27 :mime-version:content-type;
\r
28 bh=6JN1/UG2OcNqRLckC6cgb48Kpu3yz8d5JrRznYnOg9g=;
\r
29 b=pg4T9USBs5dn4UBXO4CjMiFEL3CBaft7bVPiErz1uTXyvQL1IGxHGmN4g6PIWJM4lY
\r
30 M+3XZxLwR7B2TInROqm4/qmfWw6XGO6/gjnn7u2UONggbCuBY9LfVne/Kv7gkCfsNRtW
\r
31 UrTGx5cxQeapvn7sKdD8Q24NDPbi3WjtZnyx0=
\r
32 Received: by 10.229.75.142 with SMTP id y14mr6876907qcj.16.1326833880600;
\r
33 Tue, 17 Jan 2012 12:58:00 -0800 (PST)
\r
34 Received: from localhost (luw017.wlan.gapsa.upenn.edu. [128.91.230.146])
\r
35 by mx.google.com with ESMTPS id a19sm45787924qau.21.2012.01.17.12.57.59
\r
36 (version=TLSv1/SSLv3 cipher=OTHER);
\r
37 Tue, 17 Jan 2012 12:57:59 -0800 (PST)
\r
38 From: Aaron Ecay <aaronecay@gmail.com>
\r
39 To: Jameson Graef Rollins <jrollins@finestructure.net>,
\r
40 Notmuch Mail <notmuch@notmuchmail.org>
\r
41 Subject: Re: [PATCH 1/6] emacs: break up notmuch-show-archive-thread-internal
\r
42 into two generally useful functions
\r
43 In-Reply-To: <87sjjeytfx.fsf@servo.finestructure.net>
\r
44 References: <871uqy19yo.fsf@servo.finestructure.net>
\r
45 <1326823531-14549-1-git-send-email-jrollins@finestructure.net>
\r
46 <m2d3aiay4f.fsf@gmail.com> <87sjjeytfx.fsf@servo.finestructure.net>
\r
47 User-Agent: Notmuch/0.11+62~ge41b0d3 (http://notmuchmail.org) Emacs/24.0.92.1
\r
48 (i386-apple-darwin10.8.0)
\r
49 Date: Tue, 17 Jan 2012 15:57:58 -0500
\r
50 Message-ID: <m2vcoa9hd5.fsf@gmail.com>
\r
52 Content-Type: text/plain
\r
53 X-BeenThere: notmuch@notmuchmail.org
\r
54 X-Mailman-Version: 2.1.13
\r
56 List-Id: "Use and development of the notmuch mail system."
\r
57 <notmuch.notmuchmail.org>
\r
58 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,
\r
59 <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>
\r
60 List-Archive: <http://notmuchmail.org/pipermail/notmuch>
\r
61 List-Post: <mailto:notmuch@notmuchmail.org>
\r
62 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>
\r
63 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,
\r
64 <mailto:notmuch-request@notmuchmail.org?subject=subscribe>
\r
65 X-List-Received-Date: Tue, 17 Jan 2012 20:58:02 -0000
\r
67 On Tue, 17 Jan 2012 12:17:54 -0800, Jameson Graef Rollins <jrollins@finestructure.net> wrote:
\r
69 > We're not currently in the habit of adding doc strings for
\r
70 > non-interactive programs. Do we need to go down that route?
\r
72 It is handy for developers, since the usual documentation facilities
\r
73 (describe-function, apropos, ...) will then work for that function too.
\r
74 Emacs documentation recommends(-ish) this:
\r
76 ,----[ Elisp manual Section D.6 ]
\r
77 | An internal variable or subroutine of a Lisp program might as well
\r
78 | have a documentation string. In earlier Emacs versions, you could
\r
79 | save space by using a comment instead of a documentation string,
\r
80 | but that is no longer the case--documentation strings now take up
\r
81 | very little space in a running Emacs.
\r