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

[Nelson Elhage]

Oh, I see the problem. I wasn't paying attention -- the problem is that
C-h f substitutes "M-x <command-name>" for those keybindings, instead of
a keystroke, which is why it looks weird. That's annoying, but I'm not
sure what we can do, so I guess let's drop this patch in favor of it
looking good in the builtin help.

- Nelson

On Mon, 08 Nov 2010 12:51:24 -0500, Nelson Elhage <nelhage at MIT.EDU> wrote:
> Hm. I was looking at the result of C-h f notmuch-search-mode RET, which
> is how I'm used to looking at emacs documentation inside emacs. Having
> just checked with an 'emacs -q', it looks like the notmuch "?" buffer
> does wrap the docstring, but C-h f does not.
> 
> I feel like the right answer here is probably to make notmuch-help do
> the right thing with manually-wrapped text, since that's the standard
> thing for emacs documentation, and what emacs' built-in documentation
> expects. I can try to come up with a patch that does that if you agree.
> 
> - Nelson
> 
> On Mon, 08 Nov 2010 09:35:47 -0800, Carl Worth <cworth at cworth.org> wrote:
> > On Fri, 14 May 2010 16:42:07 -0400, Nelson Elhage <nelhage at MIT.EDU> wrote:
> > > This makes for easier reading in the *help* window.
> > 
> > How are you getting unpleasant results here?
> > 
> > I intentionally implemented manual, "incorrect" wrapping in the
> > source. The idea is that once the text is actually displayed (whether
> > view `notmuch-help' or `describe-mode') those long command names should
> > be substituted by shorter keybindings and the final result should be
> > wrapped nicely.
> > 
> > For example, what I currently get after pressing "?" in a notmuch-search
> > buffer is as follows:
> > 
> > ---
> > Pressing RET on any line displays that thread. The '+' and '-'
> > keys can be used to add or remove tags from a thread. The 'a' key
> > is a convenience for archiving a thread (removing the "inbox"
> > tag). The '*' key can be used to add or remove a tag from all
> > threads in the current buffer.
> > 
> > Other useful commands are 'f' for filtering the current search
> > based on an additional query string, 't' for filtering to include
> > only messages with a given tag, and 's' to execute a new, global
> > search.
> > ---
> > 
> > And I think your wrapping change would make that displayed result
> > incorrect.
> > 
> > Is there something different about your environment that's making this
> > not work as desired?
> > 
> > -Carl
> > 
> > -- 
> > carl.d.worth at intel.com
> Non-text part: application/pgp-signature
> _______________________________________________
> notmuch mailing list
> notmuch at notmuchmail.org
> http://notmuchmail.org/mailman/listinfo/notmuch
>