From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#35498: 26.2; doc string of `isearch-regexp-function' Date: Fri, 03 May 2019 12:24:15 +0300 Message-ID: <831s1fopq8.fsf@gnu.org> References: <95f9cdd4-4d43-458e-8354-dfc8972b14bf@default> Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="26154"; mail-complaints-to="usenet@blaine.gmane.org" Cc: 35498-done@debbugs.gnu.org To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri May 03 23:20:04 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 1hMfap-0012u5-Rm for geb-bug-gnu-emacs@m.gmane.org; Fri, 03 May 2019 23:19:43 +0200 Original-Received: from localhost ([127.0.0.1]:37096 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hMURM-0003iF-GY for geb-bug-gnu-emacs@m.gmane.org; Fri, 03 May 2019 05:25:12 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:37228) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hMURE-0003gl-3i for bug-gnu-emacs@gnu.org; Fri, 03 May 2019 05:25:04 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hMURC-00006u-SD for bug-gnu-emacs@gnu.org; Fri, 03 May 2019 05:25:04 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:34182) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1hMURC-00006c-Nv for bug-gnu-emacs@gnu.org; Fri, 03 May 2019 05:25:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1hMURC-0002k0-Hj for bug-gnu-emacs@gnu.org; Fri, 03 May 2019 05:25:02 -0400 Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-To: bug-gnu-emacs@gnu.org Resent-Date: Fri, 03 May 2019 09:25:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: cc-closed 35498 X-GNU-PR-Package: emacs Mail-Followup-To: 35498@debbugs.gnu.org, eliz@gnu.org, drew.adams@oracle.com Original-Received: via spool by 35498-done@debbugs.gnu.org id=D35498.155687548110502 (code D ref 35498); Fri, 03 May 2019 09:25:02 +0000 Original-Received: (at 35498-done) by debbugs.gnu.org; 3 May 2019 09:24:41 +0000 Original-Received: from localhost ([127.0.0.1]:47725 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1hMUQr-0002jK-9W for submit@debbugs.gnu.org; Fri, 03 May 2019 05:24:41 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:50928) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1hMUQp-0002j7-Tn for 35498-done@debbugs.gnu.org; Fri, 03 May 2019 05:24:40 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:34097) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hMUQk-0008Ju-Fd; Fri, 03 May 2019 05:24:34 -0400 Original-Received: from [176.228.60.248] (port=4907 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1hMUQj-0006q3-TO; Fri, 03 May 2019 05:24:34 -0400 In-reply-to: <95f9cdd4-4d43-458e-8354-dfc8972b14bf@default> (message from Drew Adams on Mon, 29 Apr 2019 18:48:48 -0700 (PDT)) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] 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:158718 Archived-At: > Date: Mon, 29 Apr 2019 18:48:48 -0700 (PDT) > From: Drew Adams > > The doc string should describe the possible values and their > meanings/behaviors. Currently it describes only a function as value. 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. > 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'. See above: not needed. > 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. Added. > Also, "plain search string" and "regexp" are unclear here. The > distinction is presumably (?) that the former contains no regexp special > chars? Or does the return value need to be a _valid_ (complete) regexp, > and does the function raise an error if that's not possible? I didn't see any problem here, although I improved the wording to some extent. Thanks.