debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-11-24 20:08:10 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

emacs: Clean up a few documentation strings

Browse source 
Correct some grammatical errors, fix some violations of standard
documentation string formatting conventions, and be more precise.
This commit is contained in:
Austin Clements 2013-10-05 23:22:45 -04:00 committed by David Bremner
parent e1fba87327
commit adfff87a71
2 changed files with 15 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
emacs/notmuch-show.el
View file

@ -1575,7 +1575,7 @@ shown."
(notmuch-show-archive-thread-then-next))) (notmuch-show-archive-thread-then-next)))
(defun notmuch-show-rewind () (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 Specifically, if the beginning of the previous email is fewer
than `window-height' lines from the current point, move to it 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))) (view-buffer buf 'kill-buffer-if-not-modified)))
(defun notmuch-show-pipe-message (entire-thread command) (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 COMMAND will be executed with the raw contents of the current
current email message as stdin. Anything printed by the command email message as stdin. Anything printed by the command to stdout
to stdout or stderr will appear in the *notmuch-pipe* buffer. or stderr will appear in the *notmuch-pipe* buffer.
When invoked with a prefix argument, the command will receive all If ENTIRE-THREAD is non-nil (or when invoked with a prefix
open messages in the current thread (formatted as an mbox) rather argument), COMMAND will receive all open messages in the current
than only the current message." thread (formatted as an mbox) rather than only the current
message."
(interactive (let ((query-string (if current-prefix-arg (interactive (let ((query-string (if current-prefix-arg
"Pipe all open messages to command: " "Pipe all open messages to command: "
"Pipe message 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 () (defun notmuch-show-open-or-close-all ()
"Set the visibility all of the messages in the current thread. "Set the visibility all of the messages in the current thread.
By default make all of the messages visible. With a prefix By default make all of the messages visible. With a prefix
argument, hide all of the messages." argument, hide all of the messages."
(interactive) (interactive)

10
emacs/notmuch.el
View file

@ -869,15 +869,15 @@ PROMPT is the string to prompt with."
;;;###autoload ;;;###autoload
(defun notmuch-search (&optional query oldest-first target-thread target-line) (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: Other optional parameters are used as follows:
oldest-first: A Boolean controlling the sort order of returned threads OLDEST-FIRST: A Boolean controlling the sort order of returned threads
target-thread: A thread ID (without the thread: prefix) that will be made TARGET-THREAD: A thread ID (without the thread: prefix) that will be made
current if it appears in the search results. 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. appear in the search results.
When called interactively, this will prompt for a query and use When called interactively, this will prompt for a query and use