From adfff87a7161473a293bb57b2c178d7dbe267224 Mon Sep 17 00:00:00 2001 From: Austin Clements Date: Sat, 5 Oct 2013 23:22:45 -0400 Subject: [PATCH] emacs: Clean up a few documentation strings Correct some grammatical errors, fix some violations of standard documentation string formatting conventions, and be more precise. --- emacs/notmuch-show.el | 18 ++++++++++-------- emacs/notmuch.el | 10 +++++----- 2 files changed, 15 insertions(+), 13 deletions(-) diff --git a/emacs/notmuch-show.el b/emacs/notmuch-show.el index 5d7e24b2..7758eaf9 100644 --- a/emacs/notmuch-show.el +++ b/emacs/notmuch-show.el @@ -1575,7 +1575,7 @@ shown." (notmuch-show-archive-thread-then-next))) (defun notmuch-show-rewind () - "Backup through the thread, (reverse scrolling compared to \\[notmuch-show-advance-and-archive]). + "Backup through the thread (reverse scrolling compared to \\[notmuch-show-advance-and-archive]). Specifically, if the beginning of the previous email is fewer than `window-height' lines from the current point, move to it @@ -1723,15 +1723,16 @@ to show, nil otherwise." (view-buffer buf 'kill-buffer-if-not-modified))) (defun notmuch-show-pipe-message (entire-thread command) - "Pipe the contents of the current message (or thread) to the given command. + "Pipe the contents of the current message (or thread) to COMMAND. -The given command will be executed with the raw contents of the -current email message as stdin. Anything printed by the command -to stdout or stderr will appear in the *notmuch-pipe* buffer. +COMMAND will be executed with the raw contents of the current +email message as stdin. Anything printed by the command to stdout +or stderr will appear in the *notmuch-pipe* buffer. -When invoked with a prefix argument, the command will receive all -open messages in the current thread (formatted as an mbox) rather -than only the current message." +If ENTIRE-THREAD is non-nil (or when invoked with a prefix +argument), COMMAND will receive all open messages in the current +thread (formatted as an mbox) rather than only the current +message." (interactive (let ((query-string (if current-prefix-arg "Pipe all open messages to command: " "Pipe message to command: "))) @@ -1823,6 +1824,7 @@ See `notmuch-tag' for information on the format of TAG-CHANGES." (defun notmuch-show-open-or-close-all () "Set the visibility all of the messages in the current thread. + By default make all of the messages visible. With a prefix argument, hide all of the messages." (interactive) diff --git a/emacs/notmuch.el b/emacs/notmuch.el index 0ff248b9..a36849f8 100644 --- a/emacs/notmuch.el +++ b/emacs/notmuch.el @@ -869,15 +869,15 @@ PROMPT is the string to prompt with." ;;;###autoload (defun notmuch-search (&optional query oldest-first target-thread target-line) - "Run \"notmuch search\" with the given `query' and display results. + "Display threads matching QUERY in a notmuch-search buffer. -If `query' is nil, it is read interactively from the minibuffer. +If QUERY is nil, it is read interactively from the minibuffer. Other optional parameters are used as follows: - oldest-first: A Boolean controlling the sort order of returned threads - target-thread: A thread ID (without the thread: prefix) that will be made + OLDEST-FIRST: A Boolean controlling the sort order of returned threads + TARGET-THREAD: A thread ID (without the thread: prefix) that will be made current if it appears in the search results. - target-line: The line number to move to if the target thread does not + TARGET-LINE: The line number to move to if the target thread does not appear in the search results. When called interactively, this will prompt for a query and use -- 2.43.0