Subject: Re: bug#24312: 25.1.50; doc string of `tags-query-replace' - wrong signature
From: Eli Zaretskii <[email-masked]>
To: Drew Adams <[email-masked]>
Cc: [email-masked]
Date: Fri, 26 Aug 2016 20:35:52 +0300
List-Id: <debbugs-submit.debbugs.gnu.org>

tags 24312 + wontfix
thanks

> Date: Fri, 26 Aug 2016 09:37:15 -0700 (PDT)
> From: Drew Adams <[email-masked]>
> 
> The doc string refers to parameters that are not in the calling sequence
> (signature).
> 
> The signature is wrong.  It says this:
> 
> (tags-query-replace FROM TO &optional DELIMITED FILE-LIST-FORM)
> 
> But it should say this:
> 
> (tags-query-replace FROM TO &optional DELIMITED FILE-LIST-FORM
>                                       START END)
> 
> 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.