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: Re: todo-mode doc bug Date: Wed, 27 Apr 2016 11:22:31 +0200 Message-ID: <87mvofv220.fsf@gmx.net> 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> <8337q7zb9h.fsf@gnu.org> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: ger.gmane.org 1461748972 12517 80.91.229.3 (27 Apr 2016 09:22:52 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Wed, 27 Apr 2016 09:22:52 +0000 (UTC) Cc: emacs-devel@gnu.org To: Eli Zaretskii Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Wed Apr 27 11:22:43 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 1avLgB-0006Ux-Gr for ged-emacs-devel@m.gmane.org; Wed, 27 Apr 2016 11:22:43 +0200 Original-Received: from localhost ([::1]:41970 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1avLgB-0003uz-0S for ged-emacs-devel@m.gmane.org; Wed, 27 Apr 2016 05:22:43 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:60871) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1avLg6-0003sM-JP for emacs-devel@gnu.org; Wed, 27 Apr 2016 05:22:39 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1avLg1-0007u9-KN for emacs-devel@gnu.org; Wed, 27 Apr 2016 05:22:38 -0400 Original-Received: from mout.gmx.net ([212.227.15.18]:56120) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1avLg1-0007te-BL; Wed, 27 Apr 2016 05:22:33 -0400 Original-Received: from rosalinde ([89.245.106.79]) by mail.gmx.com (mrgmx003) with ESMTPSA (Nemesis) id 0Lg0wl-1bT64K3zzP-00pbNu; Wed, 27 Apr 2016 11:22:32 +0200 In-Reply-To: <8337q7zb9h.fsf@gnu.org> (Eli Zaretskii's message of "Wed, 27 Apr 2016 11:50:02 +0300") User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/25.0.93 (gnu/linux) X-Provags-ID: V03:K0:mVr8wGPWkZ+F/POxapbFh4RvJcprM16+6NVgsNLlkV1TXbhS3pC mKAlUq58tOfTTkKpI8srOWnLm79By9MU8oZ00N6iXXLZ8nlT4eTZToNW6McR857Cb3KKz3S F3Zp7mCb0blG2ZibjrTB3GuhGipk+mVXjBsQp9FnnEFqmzuVglusCyKmknRmV3u/phy84rP kZgEAWfzo+N743aCeM+hA== X-UI-Out-Filterresults: notjunk:1;V01:K0:aS46GjtFsuo=:uk98wwsuz/bkTxkwIFnDzF J7FmcR6W6D8khHpiiamHM/n2Sk2vKbFXkdTh25XxEUN3ZPBq3HEN+a3Bnvvtskv5nWlOAL5Ot /CprelQQtQP6Wv408mEjL2aTw3HkMSE5uHkpGORse/kyEHUmjJHvCpVfSb8Mz6V0TtjHuH3/Y GLqDt7Ha3zY/Z4rghx/Swth74bSmSwcUO6mXtfHOS56o+WUOp430lH8V62F9hTTg+KNzb7Kw8 GROHAAtlp+vYM/TB7TvA62KvzDCXukVPMFnW61eSF0KzwgCX9fiPucatHjLBR/eIcBz1L3PeN 5fqsGWBTvcgedshn55zlVEXOkTXhYL8X7KUyzv1g/p3GxGr8ZWYGApr1b33iq/2ll6xbWpR2N Rrgm4GJNKe9+3qEZhzfQCTJOSpvuO7lZCDl6n0D9Zn4zCMl/DYVWwvPY35v6WOgy4OBSHXtk3 /ZHY8gMI/zpD0ugucS0bWuKVlI1UFVvPbZg3oVUI5TvrW+TNeyTDeJfpT49KQlMqgdrcXoac9 DoZb3rrSoz3ZkH7M6pa0BtSe6mwYWUyh6jeC2aU6SDs++ztSlp207v19EZbTbD/D4AiIMTAcz QV0/aTCWvG14VALF2XrPUzduYZ+CTff6JaC0AZxh2d/W2q7apsU0lty9D4skgvIJ/TMhwIIX0 XFgpcg+/zZsKKihN3whcTOM2Oc/+OGqjIf4hLIx2JR0Gevg7Cmcb+HI44vEzQEE0W3p8Z3Mpg fl3c1te9en8R0ja4U06H33RUGTcIggvzUCsmbn3cu7hGxRuSexHaO51eTZYULqBZE/fVFD09 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 212.227.15.18 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:203381 Archived-At: On Wed, 27 Apr 2016 11:50:02 +0300 Eli Zaretskii wrote: >> 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? Sorry. I thought asking for further clarification of what you meant by "discussion of the issue" was out of proportion to the significance of this doc bug; in future I'll try to be less restrained. > 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. It didn't occur to me that you meant that specific message (it would have be clear to me if you had referred directly to it rather than to "discussion of the issue", but it's my fault for not asking for further clarification.) I guess the only repair it to revert my commit and then make a new one with the reference. Should I do that? Steve Berman