From: Mark Walters Date: Sun, 6 Oct 2013 20:14:04 +0000 (+0100) Subject: Re: [PATCH 4/6] emacs: Support overriding help and describing prefix action X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=28d2c07c28b19668efd2f6d578d6a159ddb3ff99;p=notmuch-archives.git Re: [PATCH 4/6] emacs: Support overriding help and describing prefix action --- diff --git a/ab/8a5d87924d7004043204f96c7e6499cbe6bfc7 b/ab/8a5d87924d7004043204f96c7e6499cbe6bfc7 new file mode 100644 index 000000000..0a00412a6 --- /dev/null +++ b/ab/8a5d87924d7004043204f96c7e6499cbe6bfc7 @@ -0,0 +1,178 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id 4D132431FBC + for ; Sun, 6 Oct 2013 13:14:29 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: -1.098 +X-Spam-Level: +X-Spam-Status: No, score=-1.098 tagged_above=-999 required=5 + tests=[DKIM_ADSP_CUSTOM_MED=0.001, FREEMAIL_FROM=0.001, + NML_ADSP_CUSTOM_MED=1.2, RCVD_IN_DNSWL_MED=-2.3] autolearn=disabled +Received: from olra.theworths.org ([127.0.0.1]) + by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id 84BzyTUCfjsZ for ; + Sun, 6 Oct 2013 13:14:23 -0700 (PDT) +Received: from mail2.qmul.ac.uk (mail2.qmul.ac.uk [138.37.6.6]) + (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id 0A5EA431FAF + for ; Sun, 6 Oct 2013 13:14:23 -0700 (PDT) +Received: from smtp.qmul.ac.uk ([138.37.6.40]) + by mail2.qmul.ac.uk with esmtp (Exim 4.71) + (envelope-from ) + id 1VSuiM-0000fE-Ln; Sun, 06 Oct 2013 21:14:09 +0100 +Received: from 93-97-24-31.zone5.bethere.co.uk ([93.97.24.31] helo=localhost) + by smtp.qmul.ac.uk with esmtpsa (TLSv1:AES128-SHA:128) (Exim 4.71) + (envelope-from ) + id 1VSuiM-0007C9-AE; Sun, 06 Oct 2013 21:14:06 +0100 +From: Mark Walters +To: Austin Clements , notmuch@notmuchmail.org +Subject: Re: [PATCH 4/6] emacs: Support overriding help and describing prefix + action +In-Reply-To: <1381029768-11883-5-git-send-email-amdragon@mit.edu> +References: <1381029768-11883-1-git-send-email-amdragon@mit.edu> + <1381029768-11883-5-git-send-email-amdragon@mit.edu> +User-Agent: Notmuch/0.16 (http://notmuchmail.org) Emacs/24.3.1 + (x86_64-pc-linux-gnu) +Date: Sun, 06 Oct 2013 21:14:04 +0100 +Message-ID: <87wqlqqhrn.fsf@qmul.ac.uk> +MIME-Version: 1.0 +Content-Type: text/plain +X-Sender-Host-Address: 93.97.24.31 +X-QM-SPAM-Info: Sender has good ham record. :) +X-QM-Body-MD5: 4b1b0e1d5fb09106fd36f4b71bfaeb7a (of first 20000 bytes) +X-SpamAssassin-Score: 0.0 +X-SpamAssassin-SpamBar: / +X-SpamAssassin-Report: The QM spam filters have analysed this message to + determine if it is + spam. We require at least 5.0 points to mark a message as spam. + This message scored 0.0 points. Summary of the scoring: + * 0.0 FREEMAIL_FROM Sender email is commonly abused enduser mail + provider * (markwalters1009[at]gmail.com) + * 0.0 AWL AWL: From: address is in the auto white-list +X-QM-Scan-Virus: ClamAV says the message is clean +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Sun, 06 Oct 2013 20:14:29 -0000 + + +This whole series looks good to me. If you are rolling another version +for any reason I have one trivial comment + +On Sun, 06 Oct 2013, Austin Clements wrote: +> Traditionally, function documentation strings are intended primarily +> for programmers, rather than users. They're written from the +> perspective of calling the function, not interactively invoking it. +> They're only ever displayed along with the function prototype (and +> often refer to argument names). And built-in help commands like +> `describe-bindings' show the name of the command, not its +> documentation. +> +> The notmuch help system is like `describe-bindings', but tries to be +> more user-friendly by displaying documentation strings, rather than +> Elisp command names. For most commands, this is fine, but for some +> the "programmer description" is inappropriate for interactive use. +> This is particularly noticeable for commands that take an optional +> prefix argument. +> +> This patch adds support for two symbol properties: notmuch-doc and +> notmuch-prefix-doc, which let a command override its interactive +> documentation and provide separate documentation for its prefixed +> invocation. If notmuch-prefix-doc is present, we add an extra line to +> the help giving the prefixed key sequence along with the documentation +> for the prefixed command. +> --- +> emacs/notmuch.el | 29 ++++++++++++++++++++++++----- +> 1 file changed, 24 insertions(+), 5 deletions(-) +> +> diff --git a/emacs/notmuch.el b/emacs/notmuch.el +> index a36849f..278bd35 100644 +> --- a/emacs/notmuch.el +> +++ b/emacs/notmuch.el +> @@ -140,7 +140,7 @@ This is basically just `format-kbd-macro' but we also convert ESC to M-." +> "M-" +> (concat desc " ")))) +> +> -(defun notmuch-describe-keymap (keymap &optional prefix tail) +> +(defun notmuch-describe-keymap (keymap ua-keys &optional prefix tail) +> "Return a list of strings, each describing one key in KEYMAP. +> +> Each string gives a human-readable description of the key and the + +It would be nice to document the ua-keys variable here. It took me some +time to work out what was going in (and I worked out based on the +caller). + +Best wishes + +Mark + +> @@ -151,10 +151,19 @@ first line of documentation for the bound function." +> ((keymapp binding) +> (setq tail +> (notmuch-describe-keymap +> - binding (notmuch-prefix-key-description key) tail))) +> + binding ua-keys (notmuch-prefix-key-description key) tail))) +> (t +> + (when (and ua-keys (symbolp binding) +> + (get binding 'notmuch-prefix-doc)) +> + ;; Documentation for prefixed command +> + (let ((ua-desc (key-description ua-keys))) +> + (push (concat ua-desc " " prefix (format-kbd-macro (vector key)) +> + "\t" (get binding 'notmuch-prefix-doc)) +> + tail))) +> + ;; Documentation for command +> (push (concat prefix (format-kbd-macro (vector key)) "\t" +> - (notmuch-documentation-first-line binding)) +> + (or (and (symbolp binding) (get binding 'notmuch-doc)) +> + (notmuch-documentation-first-line binding))) +> tail)))) +> keymap) +> tail) +> @@ -165,14 +174,24 @@ first line of documentation for the bound function." +> (while (string-match "\\\\{\\([^}[:space:]]*\\)}" doc beg) +> (let* ((keymap-name (substring doc (match-beginning 1) (match-end 1))) +> (keymap (symbol-value (intern keymap-name))) +> - (desc-list (notmuch-describe-keymap keymap)) +> + (ua-keys (where-is-internal 'universal-argument keymap t)) +> + (desc-list (notmuch-describe-keymap keymap ua-keys)) +> (desc (mapconcat #'identity desc-list "\n"))) +> (setq doc (replace-match desc 1 1 doc))) +> (setq beg (match-end 0))) +> doc)) +> +> (defun notmuch-help () +> - "Display help for the current notmuch mode." +> + "Display help for the current notmuch mode. +> + +> +This is similar to `describe-function' for the current major +> +mode, but bindings tables are shown with documentation strings +> +rather than command names. By default, this uses the first line +> +of each command's documentation string. A command can override +> +this by setting the 'notmuch-doc property of its command symbol. +> +A command that supports a prefix argument can explicitly document +> +its prefixed behavior by setting the 'notmuch-prefix-doc property +> +of its command symbol." +> (interactive) +> (let* ((mode major-mode) +> (doc (substitute-command-keys (notmuch-substitute-command-keys (documentation mode t))))) +> -- +> 1.8.4.rc3 +> +> _______________________________________________ +> notmuch mailing list +> notmuch@notmuchmail.org +> http://notmuchmail.org/mailman/listinfo/notmuch