From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Stephen Berman Newsgroups: gmane.emacs.devel Subject: todo-mode doc bug (was: [Emacs-diffs] emacs-25 e5c17f4: Fix todo-mode category movement) Date: Mon, 25 Apr 2016 11:56:15 +0200 Message-ID: <87inz6ui4g.fsf@gmx.net> References: <20160326221513.15789.84807@vcs.savannah.gnu.org> <87d1qgu7az.fsf@gmx.net> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: ger.gmane.org 1461578209 1073 80.91.229.3 (25 Apr 2016 09:56:49 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Mon, 25 Apr 2016 09:56:49 +0000 (UTC) To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Mon Apr 25 11:56:39 2016 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1audFu-0005n5-Pi for ged-emacs-devel@m.gmane.org; Mon, 25 Apr 2016 11:56:38 +0200 Original-Received: from localhost ([::1]:58829 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1audFu-0002H8-5v for ged-emacs-devel@m.gmane.org; Mon, 25 Apr 2016 05:56:38 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:41655) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1audFe-0002EC-2B for emacs-devel@gnu.org; Mon, 25 Apr 2016 05:56:23 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1audFa-0003So-Sx for emacs-devel@gnu.org; Mon, 25 Apr 2016 05:56:21 -0400 Original-Received: from mout.gmx.net ([212.227.15.19]:56986) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1audFa-0003SJ-Jd for emacs-devel@gnu.org; Mon, 25 Apr 2016 05:56:18 -0400 Original-Received: from rosalinde ([89.245.86.129]) by mail.gmx.com (mrgmx002) with ESMTPSA (Nemesis) id 0MDQUP-1avQyw2bmP-00GpCs for ; Mon, 25 Apr 2016 11:56:15 +0200 User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/25.0.93 (gnu/linux) X-Provags-ID: V03:K0:k0zCsbTbGQRh/ifmKgTsQI7eGwAXgBMAnHl7KKDsGdqU0CIpZTu Q+227eIHmJxQyspTMZK/sz2dvvvc/WI46v9Kr72TSk0n8sYI3jXGxas9US0K+QA9I2e1mC1 g70CpSgTTjo32cniZx9BfbwgGCle3JS2cp2+yq8QNBrlOL1v7TyzdDsRSayOKjJ3HWsBLdu nFbXgH4c6LiZj2lu9vYOQ== X-UI-Out-Filterresults: notjunk:1;V01:K0:NZqcLMdUioM=:dMO0C5i7NRE5+t1rO953QV Fx0TdqFVLFkxTxD7nJ2Oxr2YNW/Y49VwRT4Ww/4bIRZ/m9w6sCXoFZiMpyVri+ATzgv5odMki wm5gvMKAlecrAt9Og07Y96SxwS+8aDsXneBNBwDMcC7mjM/xN11j+lNbDptjnKKMyZCLEhRoo HRAOIT0zU0vBlCz9lq1suUmKeb6kdBvanlix8E9Wz1/WmL9O6jv3qbIU2YIP473mHAO8E5j3o PuaplROIPujwp2ZasyK93zTT5btqTJPeiIPH/WdbN/z4k+FvcdwFcoXPY42HGRkibbG2Goc1/ j+fPuF+9NVK6klh4svIkpEKofImqepvFPMTCls4EjArmgkWSqE9D4pghogrAwSH7dPcZBfUug B4CyO8+Rj6G/V9W9oNMelrtpBmN8Bnjkayi0xuOfrsFqCNlEIW13I3EUtuiL3keBvYbZ+6VEm UPD0N9VZewrcX7RxoOcefob1sDWpiaKN0h4dkMorR5cvtOdbUYbkBq3haQtfmL3L51uKkWelH w8NnGvWJ5qGK6ReXaeN77pGlbF1JitPy9qikHleiHtOHovIFdSYuGhFcX2P3MQN6nS35q3Ow6 onzPLmmGLjsBBM73bXU/b8cFjHkMsulxzq071ufN+v8q84pRaE31McgVz2vGE0TEkLx5nDxYZ ZsptXYnZ5E5+wXKLBuB+vf+FKUbJNM8AeUqV7LnphXB/zkB1oUaamkoXUZ8nC8rJ2hSQXduoe 9UXjfOMD56thLf2nNi0+heFnukicq9m1PWrTmk8bY96K/DYEk7ouKJSjNJjEKVhc9rmbJP18 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 212.227.15.19 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.org gmane.emacs.devel:203286 Archived-At: On Sun, 03 Apr 2016 11:22:26 -0700 John Wiegley wrote: >>>>>> Stephen Berman 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)))