GNU bug report logs - #16102
24.3.50; doc string of `query-replace-compile-replacement': REGEXP-FLAG

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 16102 in the body.
You can then email your comments to 16102 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Drew Adams <drew.adams <at> oracle.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 24.3.50; doc string of `query-replace-compile-replacement':
 REGEXP-FLAG
Date: Tue, 10 Dec 2013 10:44:30 -0800 (PST)

Describe parameter REGEXP-FLAG.  Doc strings should describe the
functions parameters.  (Code should not be committed without a check for
this.)

In GNU Emacs 24.3.50.2 (i686-pc-mingw32)
 of 2013-11-28 on LEG570
Bzr revision: 115271 rgm <at> gnu.org-20131128203155-qjc1xsp19z2k64b2
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --enable-checking 'CFLAGS=-O0 -g3' CPPFLAGS=-DGLYPH_DEBUG=1'

Message #8 received at 16102 <at> debbugs.gnu.org (full text, mbox):

From: Drew Adams <drew.adams <at> oracle.com>
To: 16102 <at> debbugs.gnu.org
Subject: RE: bug#16102: 24.3.50; doc string of
 `query-replace-compile-replacement': REGEXP-FLAG
Date: Tue, 10 Dec 2013 13:59:18 -0800 (PST)

Similarly, for the other doc strings that are missing a description
of parameter REGEXP-FLAG.  It is fine to refer to another doc string
for the description (that only requires a click by the user).
It is not fine for the doc string to say nothing about the parameter.

Message #11 received at 16102 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 16102 <at> debbugs.gnu.org
Subject: Re: bug#16102: 24.3.50;
 doc string of `query-replace-compile-replacement': REGEXP-FLAG
Date: Fri, 07 Feb 2014 19:00:25 -0800

Drew Adams <drew.adams <at> oracle.com> writes:

> Describe parameter REGEXP-FLAG.  Doc strings should describe the
> functions parameters.  (Code should not be committed without a check for
> this.)

If it's obvious what the parameters do, wittering on about them in the
doc strings serve no purpose.

These are all pretty internalish functions.  If you don't get that the
meaning of REGEXP-FLAG in all these functions means that we're doing
regexp searches instead of non-regexp searches, you're probably doing
something wrong.

-- 
(domestic pets only, the antidote for overdose, milk.)
  bloggy blog http://lars.ingebrigtsen.no/

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.