Todo mode doc bug fix

* lisp/calendar/todo-mode.el (todo-show): Correct obsolete and no
longer correct information in doc string.
This commit is contained in:
Stephen Berman 2016-04-27 10:18:02 +02:00
parent e55d0db957
commit 6858e77c41

View file

@ -612,11 +612,12 @@ Otherwise, `todo-show' always visits `todo-default-todo-file'."
(defun todo-show (&optional solicit-file interactive) (defun todo-show (&optional solicit-file interactive)
"Visit a todo file and display one of its categories. "Visit a todo file and display one of its categories.
When invoked in Todo mode, prompt for which todo file to visit. When invoked in Todo mode, Todo Archive mode or Todo Filtered
When invoked outside of Todo mode with non-nil prefix argument Items mode, or when invoked anywhere else with a prefix argument,
SOLICIT-FILE prompt for which todo file to visit; otherwise visit prompt for which todo file to visit. When invoked outside of a
`todo-default-todo-file'. Subsequent invocations from outside Todo mode buffer without a prefix argument, visit
of Todo mode revisit this file or, with option `todo-default-todo-file'. Subsequent invocations from outside of
Todo mode revisit this file or, with option
`todo-show-current-file' non-nil (the default), whichever todo `todo-show-current-file' non-nil (the default), whichever todo
file was last visited. file was last visited.
@ -643,10 +644,7 @@ In Todo mode just the category's unfinished todo items are shown
by default. The done items are hidden, but typing by default. The done items are hidden, but typing
`\\[todo-toggle-view-done-items]' displays them below the todo `\\[todo-toggle-view-done-items]' displays them below the todo
items. With non-nil user option `todo-show-with-done' both todo items. With non-nil user option `todo-show-with-done' both todo
and done items are always shown on visiting a category. and done items are always shown on visiting a category."
Invoking this command in Todo Archive mode visits the
corresponding todo file, displaying the corresponding category."
(interactive "P\np") (interactive "P\np")
(when todo-default-todo-file (when todo-default-todo-file
(todo-check-file (todo-absolute-file-name todo-default-todo-file))) (todo-check-file (todo-absolute-file-name todo-default-todo-file)))