todo-mode doc bug (was: [Emacs-diffs] emacs-25 e5c17f4: Fix todo-mode category movement)

[Stephen Berman]

On Sun, 03 Apr 2016 11:22:26 -0700 John Wiegley <address@hidden> wrote:

>>>>>> Stephen Berman <address@hidden> writes:
>
>> Would you prefer me to make a bug report first in such cases?
>>
>> If I encounter another such bug in todo-mode should I wait for approval from
>> a core maintainer to commit to emacs-25?
>
> Unless it's truly a trivial change, yes please.  Thanks!

I'm not sure what counts as trivial, and now have reason to ask for
clarification.  Specifically, I noticed that the doc string of
`todo-show' is in part obsolete and incorrect -- in fact, it already was
when I initially committed this version of todo-mode to the Emacs
repository, because I had failed to update the doc string after making
the change in ea3ae33b5b94bf095c52f279887009e8fb71a9df prior to the
initial commit.  (In contrast, the Todo mode Info manual contains the
correct information.)  Is it ok for me to commit the following doc
string change to emacs-25, and also dispense with a bug report?

Steve Berman

diff --git a/lisp/calendar/todo-mode.el b/lisp/calendar/todo-mode.el
index 9574c03..0529e97 100644
--- a/lisp/calendar/todo-mode.el
+++ b/lisp/calendar/todo-mode.el
@@ -612,11 +612,12 @@ todo-completion-ignore-case
 (defun todo-show (&optional solicit-file interactive)
   "Visit a todo file and display one of its categories.
 
-When invoked in Todo mode, prompt for which todo file to visit.
-When invoked outside of Todo mode with non-nil prefix argument
-SOLICIT-FILE prompt for which todo file to visit; otherwise visit
-`todo-default-todo-file'.  Subsequent invocations from outside
-of Todo mode revisit this file or, with option
+When invoked in Todo mode, Todo Archive mode or Todo Filtered
+Items mode, or when invoked anywhere else with a prefix argument,
+prompt for which todo file to visit.  When invoked outside of a
+Todo mode buffer without a prefix argument, visit
+`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
 file was last visited.
 
@@ -643,10 +644,7 @@ todo-show
 by default.  The done items are hidden, but typing
 `\\[todo-toggle-view-done-items]' displays them below the todo
 items.  With non-nil user option `todo-show-with-done' both todo
-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."
+and done items are always shown on visiting a category."
   (interactive "P\np")
   (when todo-default-todo-file
     (todo-check-file (todo-absolute-file-name todo-default-todo-file)))