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

Previous Next

Full log

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.