From: Juri Linkov <juri@jurta.org>
To: "Drew Adams" <drew.adams@oracle.com>
Cc: 13923@debbugs.gnu.org
Subject: bug#13923: 24.3.50; doc strings of Isearch commands
Date: Mon, 29 Apr 2013 09:50:28 +0300 [thread overview]
Message-ID: <87mwshvnp7.fsf@mail.jurta.org> (raw)
In-Reply-To: <E5FDA70E68AB4E5DB58B78C90856F1D7@us.oracle.com> (Drew Adams's message of "Mon, 11 Mar 2013 09:03:44 -0700")
> 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.
next prev parent reply other threads:[~2013-04-29 6:50 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-03-11 16:03 bug#13923: 24.3.50; doc strings of Isearch commands Drew Adams
2013-04-29 6:50 ` Juri Linkov [this message]
2013-04-29 13:42 ` Drew Adams
2013-04-30 6:54 ` Juri Linkov
2013-04-30 13:22 ` Drew Adams
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87mwshvnp7.fsf@mail.jurta.org \
--to=juri@jurta.org \
--cc=13923@debbugs.gnu.org \
--cc=drew.adams@oracle.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).