Re: [PATCH 2/2] emacs: notmuch-search-mode: wrap the documentation string

diff --git a/3b/3696216e9563998e215865da00afa2d5d16daf b/3b/3696216e9563998e215865da00afa2d5d16daf
new file mode 100644 (file)
index 0000000..d6bc079
--- /dev/null
+++ b/3b/3696216e9563998e215865da00afa2d5d16daf
@@ -0,0 +1,113 @@
+Return-Path: <nelhage@mit.edu>\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 71F1840DAE6\r
+       for <notmuch@notmuchmail.org>; Mon,  8 Nov 2010 09:51:45 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -1.9\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-1.9 tagged_above=-999 required=5\r
+       tests=[BAYES_00=-1.9] autolearn=ham\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 LNRWjT13gB3B for <notmuch@notmuchmail.org>;\r
+       Mon,  8 Nov 2010 09:51:33 -0800 (PST)\r
+Received: from dmz-mailsec-scanner-1.mit.edu (DMZ-MAILSEC-SCANNER-1.MIT.EDU\r
+       [18.9.25.12])\r
+       by olra.theworths.org (Postfix) with ESMTP id C937A40DAC2\r
+       for <notmuch@notmuchmail.org>; Mon,  8 Nov 2010 09:51:33 -0800 (PST)\r
+X-AuditID: 1209190c-b7ba9ae0000009f8-48-4cd838a57c16\r
+Received: from mailhub-auth-4.mit.edu ( [18.7.62.39])\r
+       by dmz-mailsec-scanner-1.mit.edu (Symantec Brightmail Gateway) with\r
+       SMTP id 40.24.02552.5A838DC4; Mon,  8 Nov 2010 12:51:33 -0500 (EST)\r
+Received: from outgoing.mit.edu (OUTGOING-AUTH.MIT.EDU [18.7.22.103])\r
+       by mailhub-auth-4.mit.edu (8.13.8/8.9.2) with ESMTP id oA8HpW8H027545; \r
+       Mon, 8 Nov 2010 12:51:33 -0500\r
+Received: from PHANATIQUE.MIT.EDU (c-71-192-162-193.hsd1.nh.comcast.net\r
+       [71.192.162.193]) (authenticated bits=0)\r
+       (User authenticated as nelhage@ATHENA.MIT.EDU)\r
+       by outgoing.mit.edu (8.13.6/8.12.4) with ESMTP id oA8HpOX4005702\r
+       (version=TLSv1/SSLv3 cipher=DHE-RSA-AES128-SHA bits=128 verify=NOT);\r
+       Mon, 8 Nov 2010 12:51:31 -0500 (EST)\r
+From: Nelson Elhage <nelhage@MIT.EDU>\r
+To: Carl Worth <cworth@cworth.org>, notmuch@notmuchmail.org\r
+Subject: Re: [PATCH 2/2] emacs: notmuch-search-mode: wrap the documentation\r
+       string\r
+In-Reply-To: <871v6vogzw.fsf@yoom.home.cworth.org>\r
+References: <1273869727-32740-1-git-send-email-nelhage@mit.edu>\r
+       <1273869727-32740-3-git-send-email-nelhage@mit.edu>\r
+       <871v6vogzw.fsf@yoom.home.cworth.org>\r
+User-Agent: Notmuch/0.4-19-g38c7247 (http://notmuchmail.org) Emacs/23.1.1\r
+       (x86_64-pc-linux-gnu)\r
+Date: Mon, 08 Nov 2010 12:51:24 -0500\r
+Message-ID: <87pqufbt5v.fsf@mit.edu>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain; charset=us-ascii\r
+X-Brightmail-Tracker: AAAAARaQIa0=\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\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, 08 Nov 2010 17:51:45 -0000\r
+\r
+Hm. I was looking at the result of C-h f notmuch-search-mode RET, which\r
+is how I'm used to looking at emacs documentation inside emacs. Having\r
+just checked with an 'emacs -q', it looks like the notmuch "?" buffer\r
+does wrap the docstring, but C-h f does not.\r
+\r
+I feel like the right answer here is probably to make notmuch-help do\r
+the right thing with manually-wrapped text, since that's the standard\r
+thing for emacs documentation, and what emacs' built-in documentation\r
+expects. I can try to come up with a patch that does that if you agree.\r
+\r
+- Nelson\r
+\r
+On Mon, 08 Nov 2010 09:35:47 -0800, Carl Worth <cworth@cworth.org> wrote:\r
+> On Fri, 14 May 2010 16:42:07 -0400, Nelson Elhage <nelhage@MIT.EDU> wrote:\r
+> > This makes for easier reading in the *help* window.\r
+> \r
+> How are you getting unpleasant results here?\r
+> \r
+> I intentionally implemented manual, "incorrect" wrapping in the\r
+> source. The idea is that once the text is actually displayed (whether\r
+> view `notmuch-help' or `describe-mode') those long command names should\r
+> be substituted by shorter keybindings and the final result should be\r
+> wrapped nicely.\r
+> \r
+> For example, what I currently get after pressing "?" in a notmuch-search\r
+> buffer is as follows:\r
+> \r
+> ---\r
+> Pressing RET on any line displays that thread. The '+' and '-'\r
+> keys can be used to add or remove tags from a thread. The 'a' key\r
+> is a convenience for archiving a thread (removing the "inbox"\r
+> tag). The '*' key can be used to add or remove a tag from all\r
+> threads in the current buffer.\r
+> \r
+> Other useful commands are 'f' for filtering the current search\r
+> based on an additional query string, 't' for filtering to include\r
+> only messages with a given tag, and 's' to execute a new, global\r
+> search.\r
+> ---\r
+> \r
+> And I think your wrapping change would make that displayed result\r
+> incorrect.\r
+> \r
+> Is there something different about your environment that's making this\r
+> not work as desired?\r
+> \r
+> -Carl\r
+> \r
+> -- \r
+> carl.d.worth@intel.com\r
+Non-text part: application/pgp-signature\r