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

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

[Drew Adams]

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@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'

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

[Drew Adams]

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.

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

[Lars Ingebrigtsen]

Drew Adams <drew.adams@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/