From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.bugs Subject: bug#35498: 26.2; doc string of `isearch-regexp-function' Date: Fri, 3 May 2019 07:47:57 -0700 (PDT) Message-ID: References: <<95f9cdd4-4d43-458e-8354-dfc8972b14bf@default>> <<831s1fopq8.fsf@gnu.org>> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="10372"; mail-complaints-to="usenet@blaine.gmane.org" Cc: 35498-done@debbugs.gnu.org To: Eli Zaretskii , Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri May 03 23:17:44 2019 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([209.51.188.17]) by blaine.gmane.org with esmtps (TLS1.0:RSA_AES_256_CBC_SHA1:256) (Exim 4.89) (envelope-from ) id 1hMfYe-0017On-Lf for geb-bug-gnu-emacs@m.gmane.org; Fri, 03 May 2019 23:17:28 +0200 Original-Received: from localhost ([127.0.0.1]:41680 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hMZUz-0007er-98 for geb-bug-gnu-emacs@m.gmane.org; Fri, 03 May 2019 10:49:17 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:50360) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hMZUm-0007eT-A8 for bug-gnu-emacs@gnu.org; Fri, 03 May 2019 10:49:09 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hMZUl-0006OM-4R for bug-gnu-emacs@gnu.org; Fri, 03 May 2019 10:49:04 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:35758) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1hMZUl-0006Nw-0A for bug-gnu-emacs@gnu.org; Fri, 03 May 2019 10:49:03 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1hMZUk-0002M7-S2 for bug-gnu-emacs@gnu.org; Fri, 03 May 2019 10:49:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Drew Adams Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 03 May 2019 14:49:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 35498 X-GNU-PR-Package: emacs Original-Received: via spool by 35498-done@debbugs.gnu.org id=D35498.15568948888965 (code D ref 35498); Fri, 03 May 2019 14:49:02 +0000 Original-Received: (at 35498-done) by debbugs.gnu.org; 3 May 2019 14:48:08 +0000 Original-Received: from localhost ([127.0.0.1]:49298 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1hMZTs-0002KX-Fd for submit@debbugs.gnu.org; Fri, 03 May 2019 10:48:08 -0400 Original-Received: from aserp2130.oracle.com ([141.146.126.79]:39568) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1hMZTp-0002Jr-Tm for 35498-done@debbugs.gnu.org; Fri, 03 May 2019 10:48:06 -0400 Original-Received: from pps.filterd (aserp2130.oracle.com [127.0.0.1]) by aserp2130.oracle.com (8.16.0.27/8.16.0.27) with SMTP id x43Ecw2f020246; Fri, 3 May 2019 14:47:59 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=oracle.com; h=mime-version : message-id : date : from : sender : to : cc : subject : references : in-reply-to : content-type : content-transfer-encoding; s=corp-2018-07-02; bh=jyEXzAvSxhh194wKfB5ZQ8zfygR2o2Qu9aTOFViOJd4=; b=CpO6fflWTS2bAVHqJCHfq36nam5VbIYVsyOq0O3onK8WyEdqzNTZ1DFs+ZcBfaq/kC2T 3kyAWpI4r4roSWEvmgrugoaLr7R1eXnTgBa1pzm3rZEWtxSfu/KYZhyngvxcONhdMxan l/QkYkDHkC/ehkIZIDHM20jqGP2aSC8zO4SpVObCab1aZzmxPPmrugYBagixy6PNiLFr DvYOSjh9lGfUnP4UtcrnF9Qe49MEQ+dCMTW9zEqw+ftyLGIyQ2q9irXt+AnM/iclvUwn OzNHijNLDx0NNuXhG2rCde/oApl/OWujBXmCyNcPcP3UcQqbGoZLRIbPVdxQz4mlPWhn FQ== Original-Received: from userp3020.oracle.com (userp3020.oracle.com [156.151.31.79]) by aserp2130.oracle.com with ESMTP id 2s6xhyq7jh-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Fri, 03 May 2019 14:47:59 +0000 Original-Received: from pps.filterd (userp3020.oracle.com [127.0.0.1]) by userp3020.oracle.com (8.16.0.27/8.16.0.27) with SMTP id x43ElhXS190854; Fri, 3 May 2019 14:47:59 GMT Original-Received: from userv0122.oracle.com (userv0122.oracle.com [156.151.31.75]) by userp3020.oracle.com with ESMTP id 2s6xhhnrdu-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Fri, 03 May 2019 14:47:58 +0000 Original-Received: from abhmp0012.oracle.com (abhmp0012.oracle.com [141.146.116.18]) by userv0122.oracle.com (8.14.4/8.14.4) with ESMTP id x43Elwcw031076; Fri, 3 May 2019 14:47:58 GMT In-Reply-To: <<831s1fopq8.fsf@gnu.org>> X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.9.1 (1003210) [OL 16.0.4834.0 (x86)] X-Proofpoint-Virus-Version: vendor=nai engine=5900 definitions=9245 signatures=668685 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 suspectscore=0 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-1810050000 definitions=main-1905030094 X-Proofpoint-Virus-Version: vendor=nai engine=5900 definitions=9245 signatures=668685 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 priorityscore=1501 malwarescore=0 suspectscore=0 phishscore=0 bulkscore=0 spamscore=0 clxscore=1011 lowpriorityscore=0 mlxscore=0 impostorscore=0 mlxlogscore=999 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1810050000 definitions=main-1905030093 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: 209.51.188.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:158704 Archived-At: > > The doc string should describe the possible values and their > > meanings/behaviors. Currently it describes only a function as value. >=20 > I added the existing functions that could be used as values. Their > descriptions are available by using the hyperlink, so no need to > duplicate that here. The list is, of course, not exhaustive, as Lisp > programs could define their own functions. It should instead, or in addition, specify what args it must accept and what kind of value it must return. Examples are only nice-to-have, not a replacement for a description/spec. > > Searching isearch.el it seems that this variable can be any of the > > values possible for `search-default-mode'. Please describe each of the > > values for `isearch-regexp-function'. >=20 > See above: not needed. The doc string should say that the value can be t, nil, or a function. It should say what the behavior is for each. Or, as I suggested, it can just say that the value can be anything acceptable for `search-default-mode'.=20 > > Even when the value is a function the description could be better, > > saying that it must accept a string as its first arg and must return a > > string. That can be surmised from saying that it converts a plain > > search string to a regexp [search string], but it could be clearer. >=20 > Added. OK, good. That cancels what I said first, above. I thought you were saying that it is sufficient to just give a list of existing such function values.