--- /dev/null
+Return-Path: <kfogel@gmail.com>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+ by olra.theworths.org (Postfix) with ESMTP id 792F0431FBD\r
+ for <notmuch@notmuchmail.org>; Mon, 7 Jul 2014 10:40:44 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.699\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.699 tagged_above=-999 required=5\r
+ tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, FREEMAIL_FROM=0.001,\r
+ RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+ by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+ with ESMTP id xr+nYA+f43ff for <notmuch@notmuchmail.org>;\r
+ Mon, 7 Jul 2014 10:40:37 -0700 (PDT)\r
+Received: from mail-ie0-f181.google.com (mail-ie0-f181.google.com\r
+ [209.85.223.181]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+ (No client certificate requested)\r
+ by olra.theworths.org (Postfix) with ESMTPS id 4AF98431FBC\r
+ for <notmuch@notmuchmail.org>; Mon, 7 Jul 2014 10:40:37 -0700 (PDT)\r
+Received: by mail-ie0-f181.google.com with SMTP id y20so3782253ier.26\r
+ for <notmuch@notmuchmail.org>; Mon, 07 Jul 2014 10:40:37 -0700 (PDT)\r
+DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113;\r
+ h=sender:from:to:cc:subject:references:reply-to:date:in-reply-to\r
+ :message-id:user-agent:mime-version:content-type;\r
+ bh=9b82qzGQy3zFwSWJs6mW34QgQJmHcf8EpcHcduLdzFY=;\r
+ b=lQsndor4PC2Yk25g7qwpNY6M+x+VavVrCEWh+P+P4dWzzVgVCpJXN8SZRuGzN+yvJl\r
+ bs3D7M4D45j1qphxMTPfrxL7aRpvnCEOmH14nR3D0BRWcAg7qoZ2KqqK7r4sKsnp3CVt\r
+ cxiW0xpDh4j60MzF5Eu0RkLJp17Lr8bs/EaswtF5t5feBazUG5I6X/ivwIDjlVKRuOd0\r
+ U4MbwIwuESYJHD7OGY68/e2LxjTLBKjfIT6t58xFwvPfiUTySqUi5eB6Yr8D/04/LeKq\r
+ svEglyBhUTuUuGEIOR68nvhf/Doikp700Xfjh2K/buKxMiinqr+EEU6IfGuIv+UAGoPm\r
+ Nx4w==\r
+X-Received: by 10.42.106.15 with SMTP id x15mr4713949ico.67.1404754836932;\r
+ Mon, 07 Jul 2014 10:40:36 -0700 (PDT)\r
+Received: from ktab.red-bean.com\r
+ (74-92-190-113-Illinois.hfc.comcastbusiness.net. [74.92.190.113])\r
+ by mx.google.com with ESMTPSA id ys2sm2699476igb.6.2014.07.07.10.40.35\r
+ for <multiple recipients>\r
+ (version=TLSv1.2 cipher=RC4-SHA bits=128/128);\r
+ Mon, 07 Jul 2014 10:40:36 -0700 (PDT)\r
+Sender: Karl Fogel <kfogel@gmail.com>\r
+From: Karl Fogel <kfogel@red-bean.com>\r
+To: Sebastian Lipp <bacuh@riseup.net>\r
+Subject: Re: [PATCH] emacs: add missing paren to fix defun in\r
+ notmuch-address.el.\r
+References: <87wqsfik5l.fsf@floss.red-bean.com>\r
+ <87mwtah2hd.fsf@zancas.localnet> <877gkeau42.fsf@floss.red-bean.com>\r
+ <m2ppy5v3mc.fsf@guru.guru-group.fi> <8738v1jtzc.fsf@nikula.org>\r
+ <87k3odgutd.fsf@zancas.localnet> <87ip3wbj7g.fsf@mcs.anl.gov>\r
+ <m2hajgxli5.fsf@guru.guru-group.fi> <87vc7vgbym.fsf@zancas.localnet>\r
+ <m2ehejykb1.fsf@guru.guru-group.fi>\r
+ <87pphmc604.fsf@verb.i-did-not-set--mail-host-address--so-tickle-me>\r
+ <87oax6vt4u.fsf@ktab.red-bean.com>\r
+ <87bnt2dy0b.fsf@verb.i-did-not-set--mail-host-address--so-tickle-me>\r
+Date: Mon, 07 Jul 2014 12:40:35 -0500\r
+In-Reply-To:\r
+ <87bnt2dy0b.fsf@verb.i-did-not-set--mail-host-address--so-tickle-me>\r
+ (Sebastian Lipp's message of "Sun, 06 Jul 2014 22:37:40 +0200")\r
+Message-ID: <87y4w5jcdo.fsf@ktab.red-bean.com>\r
+User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/24.4.50 (gnu/linux)\r
+MIME-Version: 1.0\r
+Content-Type: text/plain\r
+Cc: Tomi Ollila <tomi.ollila@iki.fi>, notmuch@notmuchmail.org\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+Reply-To: Karl Fogel <kfogel@red-bean.com>\r
+List-Id: "Use and development of the notmuch mail system."\r
+ <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Mon, 07 Jul 2014 17:40:44 -0000\r
+\r
+Sebastian Lipp <bacuh@riseup.net> writes:\r
+>> I think it's good to include an initial value (even an invalid\r
+>> placeholder one, if the real initialization has not happened yet), and a\r
+>> doc string. C-h f defvar RET will say more about how to do that.\r
+>\r
+>I hope I got that right now. (I've got no real clue of Lisp yet because\r
+>I just recently switched to emacs partly because of notmuch. :)\r
+>\r
+>How about\r
+>\r
+> (defvar bbdb-get-addresses-headers nil\r
+> "List of Addresses to import into bbdb")\r
+\r
+That's interesting -- from seeing the variable's name, I would not have\r
+guessed that it is a list.\r
+\r
+Can the doc string describe the exact format of the list, and something\r
+about how the list is initialized and used?\r
+\r
+In other words, if you were a programmer seeing this variable for the\r
+first time, and you had only a basic working knowledge of what the\r
+notmuch Elisp code does, what would you want to see in this doc string\r
+to give you a good understanding of what this variable is, how it gets\r
+set, and how it's used?\r
+\r
+One test I often use for myself is that if after I've read the doc\r
+string, I can look at any value and say whether or not it is a valid\r
+value that this variable might hold (when the code is running), then the\r
+doc string has done its job.\r
+\r
+Best,\r
+-Karl\r
projects / notmuch-archives.git / commitdiff