diff options
| author |  Mark Walters <markwalters1009@gmail.com> | 2013-07-01 08:53:59 +0100 |
|---|---|---|
| committer |  David Bremner <bremner@debian.org> | 2013-07-04 00:37:13 -0300 |
| commit | 91777f8dc94d9f292e540c23877ec72c20f68ccb (patch) | |
| tree | a9fbbfbbe0076f2eac16abddccdda9ae289ee6af /contrib | |
| parent | eb26cd1fba4749a4cf89baba86bcbf015e812ac3 (diff) | |
contrib: pick: add a docstring for the main notmuch-pick function
Diffstat (limited to 'contrib')
| -rw-r--r-- | contrib/notmuch-pick/notmuch-pick.el | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/contrib/notmuch-pick/notmuch-pick.el b/contrib/notmuch-pick/notmuch-pick.el index 11b5058e..287c3e5f 100644 --- a/contrib/notmuch-pick/notmuch-pick.el +++ b/contrib/notmuch-pick/notmuch-pick.el @@ -817,7 +817,19 @@ Complete list of currently available key bindings: (defun notmuch-pick (&optional query query-context target buffer-name open-target) - "Run notmuch pick with the given `query' and display the results" + "Run notmuch pick with the given `query' and display the results. + +The arguments are: + QUERY: the main query. This can be any query but in many cases will be + a single thread. If nil this is read interactively from the minibuffer. + QUERY-CONTEXT: is an additional term for the query. The query used + is QUERY and QUERY-CONTEXT unless that does not match any messages + in which case we fall back to just QUERY. + TARGET: A message ID (with the id: prefix) that will be made + current if it appears in the pick results. + BUFFER-NAME: the name of the buffer to show the pick tree. If + it is nil \"*notmuch-pick\" followed by QUERY is used. + OPEN-TARGET: If TRUE open the target message in the message pane." (interactive "sNotmuch pick: ") (if (null query) (setq query (notmuch-read-query "Notmuch pick: "))) |