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: Mon, 29 Apr 2013 09:50:28 +0300 Organization: JURTA Message-ID: <87mwshvnp7.fsf@mail.jurta.org> References: NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: ger.gmane.org 1367218316 11764 80.91.229.3 (29 Apr 2013 06:51:56 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Mon, 29 Apr 2013 06:51:56 +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 Mon Apr 29 08:52:01 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 1UWhwO-0001SC-Rd for geb-bug-gnu-emacs@m.gmane.org; Mon, 29 Apr 2013 08:52:00 +0200 Original-Received: from localhost ([::1]:44042 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UWhwO-00036B-GA for geb-bug-gnu-emacs@m.gmane.org; Mon, 29 Apr 2013 02:52:00 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:52425) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UWhwD-00031S-B5 for bug-gnu-emacs@gnu.org; Mon, 29 Apr 2013 02:51:50 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1UWhwC-0005kl-6L for bug-gnu-emacs@gnu.org; Mon, 29 Apr 2013 02:51:49 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:45300) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UWhwC-0005kg-2X for bug-gnu-emacs@gnu.org; Mon, 29 Apr 2013 02:51:48 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.72) (envelope-from ) id 1UWhwR-0008VE-H8 for bug-gnu-emacs@gnu.org; Mon, 29 Apr 2013 02:52:03 -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: Mon, 29 Apr 2013 06:52:03 +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.136721828132540 (code B ref 13923); Mon, 29 Apr 2013 06:52:03 +0000 Original-Received: (at 13923) by debbugs.gnu.org; 29 Apr 2013 06:51:21 +0000 Original-Received: from localhost ([127.0.0.1]:49408 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1UWhvf-0008SM-Pk for submit@debbugs.gnu.org; Mon, 29 Apr 2013 02:51:20 -0400 Original-Received: from ps18281.dreamhost.com ([69.163.218.105]:46279 helo=ps18281.dreamhostps.com) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1UWhvT-0008RS-VM for 13923@debbugs.gnu.org; Mon, 29 Apr 2013 02:51:09 -0400 Original-Received: from localhost (ps18281.dreamhostps.com [69.163.218.105]) by ps18281.dreamhostps.com (Postfix) with ESMTP id EF5ED258B9E93C; Sun, 28 Apr 2013 23:50:46 -0700 (PDT) In-Reply-To: (Drew Adams's message of "Mon, 11 Mar 2013 09:03:44 -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:73815 Archived-At: > The doc strings of `isearch-forward' etc. should describe each of the > arguments. That includes arg NO-RECURSIVE-EDIT. This applies to all > Isearch commands. The docstring of `isearch-forward' describes the whole Isearch facility for interactive use with all its available commands and keys. There is only one place to describe `isearch-forward' as a non-interactive function at the end of the docstring that already contains this text: If this function is called non-interactively, it does not return to the calling function until the search is done. that describes the effect of NO-RECURSIVE-EDIT. > The doc string of `isearch-mode', especially, needs to describe each of > its arguments. It currently describes none of them. This is described already in the Commentary section of isearch.el: ;; For programmed use of isearch-mode, e.g. calling (isearch-forward), ;; isearch-mode behaves modally and does not return until the search ;; is completed. It uses a recursive-edit to behave this way. and in the comments of `isearch-mode': ;; isearch-mode can be made modal (in the sense of not returning to ;; the calling function until searching is completed) by entering ;; a recursive-edit and exiting it when done isearching.