From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.bugs Subject: bug#31207: 26; Doc strings of commands and other functions of `replace.el' Date: Wed, 18 Apr 2018 08:28:51 -0700 (PDT) Message-ID: <5cbda7e0-323f-450f-9e64-b73fc3b39e44@default> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable X-Trace: blaine.gmane.org 1524065308 8441 195.159.176.226 (18 Apr 2018 15:28:28 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Wed, 18 Apr 2018 15:28:28 +0000 (UTC) To: 31207@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Wed Apr 18 17:28:24 2018 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1f8p0R-00022M-NX for geb-bug-gnu-emacs@m.gmane.org; Wed, 18 Apr 2018 17:28:23 +0200 Original-Received: from localhost ([::1]:34685 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1f8p2T-0005m5-QT for geb-bug-gnu-emacs@m.gmane.org; Wed, 18 Apr 2018 11:30:29 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:49487) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1f8p29-0005ft-Hf for bug-gnu-emacs@gnu.org; Wed, 18 Apr 2018 11:30:15 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1f8p24-0006nP-FF for bug-gnu-emacs@gnu.org; Wed, 18 Apr 2018 11:30:09 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:51595) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1f8p24-0006nG-Bs for bug-gnu-emacs@gnu.org; Wed, 18 Apr 2018 11:30:04 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1f8p23-000720-Td for bug-gnu-emacs@gnu.org; Wed, 18 Apr 2018 11:30:04 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Drew Adams Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 18 Apr 2018 15:30:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 31207 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.152406535526812 (code B ref -1); Wed, 18 Apr 2018 15:30:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 18 Apr 2018 15:29:15 +0000 Original-Received: from localhost ([127.0.0.1]:59492 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1f8p1G-0006yN-Mu for submit@debbugs.gnu.org; Wed, 18 Apr 2018 11:29:14 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:58068) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1f8p1E-0006yA-4R for submit@debbugs.gnu.org; Wed, 18 Apr 2018 11:29:13 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1f8p18-0006Rv-2G for submit@debbugs.gnu.org; Wed, 18 Apr 2018 11:29:06 -0400 Original-Received: from lists.gnu.org ([2001:4830:134:3::11]:40040) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1f8p17-0006Rr-VS for submit@debbugs.gnu.org; Wed, 18 Apr 2018 11:29:06 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:48990) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1f8p13-0004q3-VV for bug-gnu-emacs@gnu.org; Wed, 18 Apr 2018 11:29:05 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1f8p0y-0006Ny-Tr for bug-gnu-emacs@gnu.org; Wed, 18 Apr 2018 11:29:01 -0400 Original-Received: from aserp2120.oracle.com ([141.146.126.78]:52192) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1f8p0y-0006NR-IZ for bug-gnu-emacs@gnu.org; Wed, 18 Apr 2018 11:28:56 -0400 Original-Received: from pps.filterd (aserp2120.oracle.com [127.0.0.1]) by aserp2120.oracle.com (8.16.0.22/8.16.0.22) with SMTP id w3IFPsYt052274 for ; Wed, 18 Apr 2018 15:28:54 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=oracle.com; h=mime-version : message-id : date : from : sender : to : subject : content-type : content-transfer-encoding; s=corp-2017-10-26; bh=Sbw7qykQabs7XYcUTf+0yBVNY5HAQgfaDcWsQBSmnWo=; b=Gt0r5lp4FMzMYrAEXgemzy07q3PmV0VCh+N/SbXWOrD+SVEDObx+bHqbHZDmUk+RC2QK TfT5C9FnbyqsSBKvIOIttU+ALfW8QYIP7rK8sOzoq9FxYpVcrrY8sIpC9hpzJQL4coo4 ExvlznFOHa67KdT4liyi5fky5fj5voDFiemeqX73K0ss9Oqev6NnvlwX/ORzTg55AO4n Hy4uyQm/Tk2XORRPETnOKCq47z16RiHyetvpNtaW62IEMARmg8Ivt45BcgrEeNkGUvd4 mYtjSdDzlGMG5h9W3lVYU7n35VAA4zi/t7ogNJNsXWgDyqK//eRrdCIjvKZZqtcxPYss Qg== Original-Received: from userv0022.oracle.com (userv0022.oracle.com [156.151.31.74]) by aserp2120.oracle.com with ESMTP id 2hdrxnb8u0-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK) for ; Wed, 18 Apr 2018 15:28:54 +0000 Original-Received: from userv0121.oracle.com (userv0121.oracle.com [156.151.31.72]) by userv0022.oracle.com (8.14.4/8.14.4) with ESMTP id w3IFSr1d017466 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK) for ; Wed, 18 Apr 2018 15:28:53 GMT Original-Received: from abhmp0016.oracle.com (abhmp0016.oracle.com [141.146.116.22]) by userv0121.oracle.com (8.14.4/8.13.8) with ESMTP id w3IFSqMo023103 for ; Wed, 18 Apr 2018 15:28:53 GMT X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.9.1 (1003210) [OL 16.0.4678.0 (x86)] X-Proofpoint-Virus-Version: vendor=nai engine=5900 definitions=8866 signatures=668698 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 suspectscore=1 malwarescore=0 phishscore=0 bulkscore=0 spamscore=0 mlxscore=0 mlxlogscore=999 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1711220000 definitions=main-1804180140 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x [generic] [fuzzy] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6.x X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 208.118.235.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.org gmane.emacs.bugs:145577 Archived-At: 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 =20 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=3Dx86_64-w64-mingw32 --without-compress-install 'CFLAGS=3D-O2 -static -g3''