From: Eli Zaretskii <eliz@gnu.org>
To: Drew Adams <drew.adams@oracle.com>
Cc: rpluim@gmail.com, 31207-done@debbugs.gnu.org
Subject: bug#31207: 26; Doc strings of commands and other functions of `replace.el'
Date: Wed, 09 Oct 2019 13:14:41 +0300 [thread overview]
Message-ID: <831rvmw7hq.fsf@gnu.org> (raw)
In-Reply-To: <81b71baa-dd6c-46a5-900a-47d84492c560@default> (message from Drew Adams on Tue, 8 Oct 2019 07:37:18 -0700 (PDT))
> Date: Tue, 8 Oct 2019 07:37:18 -0700 (PDT)
> From: Drew Adams <drew.adams@oracle.com>
> Cc: 31207@debbugs.gnu.org
>
> > Drew> If you feel that this bug is completely fixed in
> > Drew> Emacs 27, please close it as "fixed". Thx.
> >
> > I canʼt answer that, because I donʼt know which of the defuns in
> > replace.el you feel are underdocumented. Please donʼt say 'all of
> > them'.
>
> Any doc string that does not describe all of
> the function arguments, either directly or
> indirectly (by referencing another doc string).
>
> This is nothing new. Function doc strings
> should describe the arguments. That's all.
What an unhelpful response. Do you realize how such responses shoot
yourself (and us) in the foot by preventing well-meaning contributors
from fixing your bug reports?
I fixed the doc strings in all functions except perform-replace. The
latter is clearly an internal function, and its doc string says so.
prev parent reply other threads:[~2019-10-09 10:14 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-04-18 15:28 bug#31207: 26; Doc strings of commands and other functions of `replace.el' Drew Adams
2019-10-06 17:27 ` Drew Adams
2019-10-07 11:36 ` Robert Pluim
2019-10-07 17:29 ` Drew Adams
2019-10-08 11:32 ` Robert Pluim
2019-10-08 14:37 ` Drew Adams
2019-10-09 10:14 ` Eli Zaretskii [this message]
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
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=831rvmw7hq.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=31207-done@debbugs.gnu.org \
--cc=drew.adams@oracle.com \
--cc=rpluim@gmail.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 public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).