unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: 31207@debbugs.gnu.org
Subject: bug#31207: 26; Doc strings of commands and other functions of `replace.el'
Date: Wed, 18 Apr 2018 08:28:51 -0700 (PDT)	[thread overview]
Message-ID: <5cbda7e0-323f-450f-9e64-b73fc3b39e44@default> (raw)

1. The doc strings of many functions do not describe all of their args,
including these:

 query-replace-read-from
 query-replace-compile-replacement
 query-replace-read-to
 query-replace
 query-replace-regexp
 replace-string
 replace-regexp
 occur-mode-goto-occurrence
 occur-next-error
 occur-rename-buffer
 multi-occur
 multi-occur-in-matching-buffers
 perform-replace
 
In many cases, it is the more recently added args which are not
documented (of the args of recently added functions).  This suggests
oversight/laziness - no one has yet bothered to DTRT for those newly
added args.

2. There are also numerous functions in this file that have no doc
strings.  They should have doc strings, and those doc strings should
describe the arguments.  For example, none of the `occur-engine'
functions have doc strings.  Laziness on the part of the person who
added them, perhaps - but this should be corrected now.

3. In some cases there are poorly named args whose names are not
explained (the args are not really described).  For example, BUFREGEXP.




In GNU Emacs 26.1 (build 1, x86_64-w64-mingw32)
 of 2018-04-10
Repository revision: c267421647510319d2a70554e42f0d1c394dba0a
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --without-dbus --host=x86_64-w64-mingw32
 --without-compress-install 'CFLAGS=-O2 -static -g3''





             reply	other threads:[~2018-04-18 15:28 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-04-18 15:28 Drew Adams [this message]
2019-10-06 17:27 ` bug#31207: 26; Doc strings of commands and other functions of `replace.el' 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

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=5cbda7e0-323f-450f-9e64-b73fc3b39e44@default \
    --to=drew.adams@oracle.com \
    --cc=31207@debbugs.gnu.org \
    /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).