GNU bug report logs - #24312
25.1.50; doc string of `tags-query-replace' - wrong signature

Previous Next

Full log

View this message in rfc822 format

From: Drew Adams <drew.adams <at> oracle.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 24312-done <at> debbugs.gnu.org
Subject: bug#24312: 25.1.50; doc string of `tags-query-replace' - wrong signature
Date: Fri, 26 Aug 2016 11:16:23 -0700 (PDT)

> > The doc string says this (correctly):
> >
> >  Fifth and sixth arguments START and END are accepted, for compatibility
> >  with ‘query-replace-regexp’, and ignored.
> 
> So it's obviously deliberate.
> 
> > The doc cannot reference optional args START and END unless they are in
> > the signature.
> 
> They are optional, so yes, the doc can do that.
> 
> Closing.

Suit yourself.

FYI, searching the doc strings of all functions defined in my session
for "ignored", I find NONE that show a signature without an optional
argument that is mentioned as being ignored.  ZERO.

On the other hand, I find all of these functions whose doc strings
state that an optional argument is ignored and that show the ignored
argument in the signature:

after-find-file
cvs-quikdir
dframe-set-timer
dired-revert
gnus-agent-regenerate
gnus-delay-initialize
iso-german
iso-gtex2iso
iso-iso2duden
iso-iso2gtex
iso-iso2sgml
iso-iso2tex
iso-sgml2iso
iso-spanish
iso-tex2iso
pcomplete-opt
url-copy-file
view-buffer-other-frame
view-buffer-other-window
widget-image-insert

Previous Next

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