From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Juri Linkov Newsgroups: gmane.emacs.bugs Subject: bug#13923: 24.3.50; doc strings of Isearch commands Date: Tue, 30 Apr 2013 09:54:17 +0300 Organization: JURTA Message-ID: <87ehdscxuu.fsf@mail.jurta.org> References: <87mwshvnp7.fsf@mail.jurta.org> <9457FCDD57DC456A9526E04663C0009C@us.oracle.com> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: ger.gmane.org 1367305014 26016 80.91.229.3 (30 Apr 2013 06:56:54 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Tue, 30 Apr 2013 06:56:54 +0000 (UTC) Cc: 13923@debbugs.gnu.org To: "Drew Adams" Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Tue Apr 30 08:56:49 2013 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1UX4UY-0006LG-MF for geb-bug-gnu-emacs@m.gmane.org; Tue, 30 Apr 2013 08:56:46 +0200 Original-Received: from localhost ([::1]:54530 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UX4UY-0007XG-D7 for geb-bug-gnu-emacs@m.gmane.org; Tue, 30 Apr 2013 02:56:46 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:33215) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UX4UU-0007Wp-7F for bug-gnu-emacs@gnu.org; Tue, 30 Apr 2013 02:56:43 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1UX4US-0005iT-R0 for bug-gnu-emacs@gnu.org; Tue, 30 Apr 2013 02:56:42 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:47331) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UX4US-0005iP-Nl for bug-gnu-emacs@gnu.org; Tue, 30 Apr 2013 02:56:40 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.72) (envelope-from ) id 1UX4Un-0005Fx-LR for bug-gnu-emacs@gnu.org; Tue, 30 Apr 2013 02:57:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Juri Linkov Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Tue, 30 Apr 2013 06:57:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 13923 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 13923-submit@debbugs.gnu.org id=B13923.136730498020137 (code B ref 13923); Tue, 30 Apr 2013 06:57:01 +0000 Original-Received: (at 13923) by debbugs.gnu.org; 30 Apr 2013 06:56:20 +0000 Original-Received: from localhost ([127.0.0.1]:51440 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1UX4U7-0005Ej-05 for submit@debbugs.gnu.org; Tue, 30 Apr 2013 02:56:20 -0400 Original-Received: from ps18281.dreamhost.com ([69.163.218.105]:60586 helo=ps18281.dreamhostps.com) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1UX4U5-0005Ec-9g for 13923@debbugs.gnu.org; Tue, 30 Apr 2013 02:56:18 -0400 Original-Received: from localhost (ps18281.dreamhostps.com [69.163.218.105]) by ps18281.dreamhostps.com (Postfix) with ESMTP id 99CC9258B9E91C; Mon, 29 Apr 2013 23:55:54 -0700 (PDT) In-Reply-To: <9457FCDD57DC456A9526E04663C0009C@us.oracle.com> (Drew Adams's message of "Mon, 29 Apr 2013 06:42:04 -0700") User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/24.3.50 (x86_64-pc-linux-gnu) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.13 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6.x X-Received-From: 140.186.70.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-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:73844 Archived-At: > Does it say that that is a description of NO-RECURSIVE-EDIT? No. Thanks for bringing attention to endless omissions in docstrings. > If that is what the intention is, please make the connection, explicitly, so > user's do not have to guess that that is what you mean. Does this patch do what you intended to achieve? === modified file 'lisp/isearch.el' --- lisp/isearch.el 2013-04-27 22:03:42 +0000 +++ lisp/isearch.el 2013-04-30 06:54:05 +0000 @@ -735,8 +735,9 @@ (defun isearch-forward (&optional regexp and are then executed normally (depending on `search-exit-option'). Likewise for function keys and mouse button events. -If this function is called non-interactively, it does not return to -the calling function until the search is done." +If this function is called non-interactively with a nil NO-RECURSIVE-EDIT, +it does not return to the calling function until the search is done. +See the function `isearch-mode' for more information." (interactive "P\np") (isearch-mode t (not (null regexp-p)) nil (not no-recursive-edit))) @@ -799,7 +800,23 @@ (defun isearch-backward-regexp (&optiona (defun isearch-mode (forward &optional regexp op-fun recursive-edit word) "Start Isearch minor mode. -It is called by the function `isearch-forward' and other related functions." +It is called by the function `isearch-forward' and other related functions. + +The non-nil arg FORWARD means searching in the forward direction. + +The non-nil arg REGEXP does an incremental regular expression search. + +The arg OP-FUN is a function to be called after each input character +is processed. (It is not called after characters that exit the search.) + +When the arg RECURSIVE-EDIT is non-nil, this function behaves modally and +does not return to the calling function until the search is completed. +To behave this way it enters a recursive-edit and exits it when done +isearching. + +The arg WORD, if t, does incremental search for a sequence of words, +ignoring punctuation. If the value is a function, it is called to +convert the search string to a regexp used by regexp search functions." ;; Initialize global vars. (setq isearch-forward forward