# HG changeset patch # User Bill Wohler # Date 1131047978 0 # Node ID f7b261d0f8e88c5fd20e1455120ab3eb91416049 # Parent b5ed6992501901db484c5bbcb75c298055c31cbf * mh-customize.el (mh-refile-preserves-sequences-flag) (mh-tick-seq, mh-update-sequences-after-mh-show-flag): Sync docstrings with manual. * mh-e.el (mh-update-sequences): Sync docstrings with manual. * mh-seq.el (mh-delete-seq, mh-list-sequences, mh-narrow-to-seq) (mh-widen, mh-toggle-tick, mh-narrow-to-tick): Sync docstrings with manual. diff -r b5ed69925019 -r f7b261d0f8e8 lisp/mh-e/ChangeLog --- a/lisp/mh-e/ChangeLog Thu Nov 03 19:40:39 2005 +0000 +++ b/lisp/mh-e/ChangeLog Thu Nov 03 19:59:38 2005 +0000 @@ -1,3 +1,15 @@ +2005-11-03 Bill Wohler + + * mh-customize.el (mh-refile-preserves-sequences-flag) + (mh-tick-seq, mh-update-sequences-after-mh-show-flag): Sync + docstrings with manual. + + * mh-e.el (mh-update-sequences): Sync docstrings with manual. + + * mh-seq.el (mh-delete-seq, mh-list-sequences, mh-narrow-to-seq) + (mh-widen, mh-toggle-tick, mh-narrow-to-tick): Sync docstrings + with manual. + 2005-11-01 Bill Wohler * mh-comp.el (mh-redist-full-contents) Convert defvar to diff -r b5ed69925019 -r f7b261d0f8e8 lisp/mh-e/mh-customize.el --- a/lisp/mh-e/mh-customize.el Thu Nov 03 19:40:39 2005 +0000 +++ b/lisp/mh-e/mh-customize.el Thu Nov 03 19:59:38 2005 +0000 @@ -1131,29 +1131,34 @@ (defcustom mh-refile-preserves-sequences-flag t "*Non-nil means that sequences are preserved when messages are refiled. -If this variable is non-nil and a message belonging to a sequence other than -cur or Previous-Sequence (see mh-profile 5) is refiled then it is put in the -same sequence in the destination folder." + +If a message is in any sequence (except \"Previous-Sequence:\" and \"cur\") +when it is refiled, then it will still be in those sequences in the +destination folder. If this behavior is not desired, then turn off this +option." :type 'boolean :group 'mh-sequences) (defcustom mh-tick-seq 'tick "The name of the MH sequence for ticked messages. -You would change this option if you already use the `tick' sequence for your -own use. You can also disable all of the ticking functions by choosing the -`Disable Ticking' item but there isn't much advantage to that." + +You can customize this option if you already use the \"tick\" sequence for +your own use. You can also disable all of the ticking functions by choosing +the \"Disable Ticking\" item but there isn't much advantage to that." :type '(choice (const :tag "Disable Ticking" nil) symbol) :group 'mh-sequences) (defcustom mh-update-sequences-after-mh-show-flag t "*Non-nil means flush MH sequences to disk after message is shown. + Three sequences are maintained internally by MH-E and pushed out to MH when a message is shown. They include the sequence specified by your -`Unseen-Sequence:' profile entry, `cur', and the sequence listed by -the `mh-tick-seq' option which is `tick' by default. -If you do not like this behavior, set this option to nil. You can then update -the state manually with the \\`\\[mh-execute-commands]', `\\[mh-quit]', or `\\[mh-update-sequences]' commands." +\"Unseen-Sequence:\" profile entry, \"cur\", and the sequence listed by the +option `mh-tick-seq' which is \"tick\" by default. If you do not like this +behavior, turn off this option. You can then update the state manually with +the `\\[mh-execute-commands]', `\\[mh-quit]', or `\\[mh-update-sequences]' +commands." :type 'boolean :group 'mh-sequences) diff -r b5ed69925019 -r f7b261d0f8e8 lisp/mh-e/mh-e.el --- a/lisp/mh-e/mh-e.el Thu Nov 03 19:40:39 2005 +0000 +++ b/lisp/mh-e/mh-e.el Thu Nov 03 19:59:38 2005 +0000 @@ -1254,8 +1254,11 @@ (defun mh-update-sequences () - "Update MH's Unseen-Sequence and current folder and message. -Flush MH-E's state out to MH. The message at the cursor becomes current." + "Flush MH-E's state out to MH. +This function updates the sequence specified by your \"Unseen-Sequence:\" +profile component, \"cur\", and the sequence listed by the `mh-tick-seq' +option which is \"tick\" by default. The message at the cursor is used for +\"cur\"." (interactive) ;; mh-update-sequences is the opposite of mh-read-folder-sequences, ;; which updates MH-E's state from MH. diff -r b5ed69925019 -r f7b261d0f8e8 lisp/mh-e/mh-seq.el --- a/lisp/mh-e/mh-seq.el Thu Nov 03 19:40:39 2005 +0000 +++ b/lisp/mh-e/mh-seq.el Thu Nov 03 19:59:38 2005 +0000 @@ -140,7 +140,11 @@ ;;;###mh-autoload (defun mh-delete-seq (sequence) - "Delete the SEQUENCE." + "Delete SEQUENCE. + +You are prompted for the sequence to delete. Note that this deletes only the +sequence, not the messages in the sequence. If you want to delete the +messages, use \"\\[universal-argument] \\[mh-delete-msg]\"." (interactive (list (mh-read-seq-default "Delete" t))) (let ((msg-list (mh-seq-to-msgs sequence)) (internal-flag (mh-internal-seq sequence)) @@ -161,7 +165,8 @@ ;;;###mh-autoload (defun mh-list-sequences () - "List the sequences defined in the folder being visited." + "List all sequences in folder. +The list appears in a buffer named \"*MH-E Sequences*\"." (interactive) (let ((folder mh-current-folder) (temp-buffer mh-sequences-buffer) @@ -228,8 +233,13 @@ ;;;###mh-autoload (defun mh-narrow-to-seq (sequence) - "Restrict display of this folder to just messages in SEQUENCE. -Use \\\\[mh-widen] to undo this command." + "Restrict display to messages in SEQUENCE. + +You are prompted for the name of the sequence. What this command does is show +only those messages that are in the selected sequence in the MH-Folder buffer. +In addition, it limits further MH-E searches to just those messages. + +When you want to widen the view to all your messages again, use \\[mh-widen]." (interactive (list (mh-read-seq "Narrow to" t))) (with-mh-folder-updating (t) (cond ((mh-seq-to-msgs sequence) @@ -296,7 +306,7 @@ ;;;###mh-autoload (defun mh-widen (&optional all-flag) - "Restore the previous limit. + "Remove last restriction. If optional prefix argument ALL-FLAG is non-nil, remove all limits." (interactive "P") (let ((msg (mh-get-msg-num nil))) @@ -1669,7 +1679,14 @@ ;;;###mh-autoload (defun mh-toggle-tick (range) - "Toggle tick mark of all messages in RANGE." + "Toggle tick mark of all messages in RANGE. + +This command adds messages to the \"tick\" sequence (which you can customize +via the option `mh-tick-seq'). This sequence can be viewed later with the +\\[mh-index-ticked-messages] command. + +Check the documentation of `mh-interactive-range' to see how RANGE is read in +interactive use." (interactive (list (mh-interactive-range "Tick"))) (unless mh-tick-seq (error "Enable ticking by customizing `mh-tick-seq'")) @@ -1696,9 +1713,13 @@ ;;;###mh-autoload (defun mh-narrow-to-tick () - "Limit to messages in `mh-tick-seq'. + "Limit to ticked messages. -Use \\\\[mh-widen] to undo this command." +What this command does is show only those messages that are in the \"tick\" +sequence (which you can customize via the `mh-tick-seq' option) in the +MH-Folder buffer. In addition, it limits further MH-E searches to just those +messages. When you want to widen the view to all your messages again, use +\\[mh-widen]." (interactive) (cond ((not mh-tick-seq) (error "Enable ticking by customizing `mh-tick-seq'"))