all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Drew Adams <drew.adams@oracle.com>
Cc: 24312-done@debbugs.gnu.org
Subject: bug#24312: 25.1.50; doc string of `tags-query-replace' - wrong signature
Date: Fri, 26 Aug 2016 20:35:52 +0300	[thread overview]
Message-ID: <83mvjzcu13.fsf@gnu.org> (raw)
In-Reply-To: <cd145ac8-31c6-4e7c-bea2-2049eef1eb41@default> (message from Drew Adams on Fri, 26 Aug 2016 09:37:15 -0700 (PDT))

tags 24312 + wontfix
thanks

> Date: Fri, 26 Aug 2016 09:37:15 -0700 (PDT)
> From: Drew Adams <drew.adams@oracle.com>
> 
> 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.





  reply	other threads:[~2016-08-26 17:35 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-08-26 16:37 bug#24312: 25.1.50; doc string of `tags-query-replace' - wrong signature Drew Adams
2016-08-26 17:35 ` Eli Zaretskii [this message]
2016-08-26 18:16   ` Drew Adams
2016-08-26 18:51 ` Noam Postavsky
2016-08-26 19:15   ` Eli Zaretskii
2016-08-26 19:52   ` Drew Adams
2016-08-27  2:38     ` npostavs

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=83mvjzcu13.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=24312-done@debbugs.gnu.org \
    --cc=drew.adams@oracle.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.