From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.devel Subject: Re: todo-mode doc bug Date: Wed, 27 Apr 2016 11:50:02 +0300 Message-ID: <8337q7zb9h.fsf@gnu.org> References: <20160326221513.15789.84807@vcs.savannah.gnu.org> <87d1qgu7az.fsf@gmx.net> <87inz6ui4g.fsf@gmx.net> <83r3du2eg2.fsf@gnu.org> <87eg9uuh3a.fsf@gmx.net> <83mvoi2diw.fsf@gnu.org> <87r3drv4yc.fsf@gmx.net> Reply-To: Eli Zaretskii NNTP-Posting-Host: plane.gmane.org X-Trace: ger.gmane.org 1461747059 13580 80.91.229.3 (27 Apr 2016 08:50:59 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Wed, 27 Apr 2016 08:50:59 +0000 (UTC) Cc: emacs-devel@gnu.org To: Stephen Berman Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Wed Apr 27 10:50:52 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 1avLBM-00065A-F8 for ged-emacs-devel@m.gmane.org; Wed, 27 Apr 2016 10:50:52 +0200 Original-Received: from localhost ([::1]:41657 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1avLBE-0007k6-Hh for ged-emacs-devel@m.gmane.org; Wed, 27 Apr 2016 04:50:44 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:50066) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1avLAs-0007ed-Ul for emacs-devel@gnu.org; Wed, 27 Apr 2016 04:50:24 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1avLAp-00072B-0Y for emacs-devel@gnu.org; Wed, 27 Apr 2016 04:50:22 -0400 Original-Received: from fencepost.gnu.org ([2001:4830:134:3::e]:43811) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1avLAo-000724-Ub; Wed, 27 Apr 2016 04:50:18 -0400 Original-Received: from 84.94.185.246.cable.012.net.il ([84.94.185.246]:2874 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_128_CBC_SHA1:128) (Exim 4.82) (envelope-from ) id 1avLAn-0001At-QA; Wed, 27 Apr 2016 04:50:18 -0400 In-reply-to: <87r3drv4yc.fsf@gmx.net> (message from Stephen Berman on Wed, 27 Apr 2016 10:19:55 +0200) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 2001:4830:134:3::e 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:203378 Archived-At: > From: Stephen Berman > Cc: emacs-devel@gnu.org > Date: Wed, 27 Apr 2016 10:19:55 +0200 > > >> There is no outstanding bug about this; my question was about whether it > >> is necessary to file one for this doc string change > > > > No need. However, mentioning in the commit log the URL for the > > discussion of the issue should be considered. > > This thread is the only discussion of this issue, so in the hope that > you agree with me that it isn't relevant to the doc bug per se and hence > wouldn't be appropriate to reference in the commit message, I've gone > ahead and committed the fix without such a reference. I often wonder why people need to assume something about what others think, instead of just asking them and waiting for an answer. What's the rush? As it happens, I don't agree. In this message: http://lists.gnu.org/archive/html/emacs-devel/2016-04/msg00738.html you say more about the rationale for the fix than in the log message for the commit you just made: 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.) Admittedly, I'm close to splitting hair here, but the references to a previous commit and to the manual are valuable and relevant information. That's why I generally advise to abandon doubt and simply include the reference in the log message, as no real harm could ever be done by doing that. Thanks.