From: "Drew Adams" <drew.adams@oracle.com>
To: "'Juri Linkov'" <juri@jurta.org>
Cc: 13923@debbugs.gnu.org
Subject: bug#13923: 24.3.50; doc strings of Isearch commands
Date: Mon, 29 Apr 2013 06:42:04 -0700 [thread overview]
Message-ID: <9457FCDD57DC456A9526E04663C0009C@us.oracle.com> (raw)
In-Reply-To: <87mwshvnp7.fsf@mail.jurta.org>
> > 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.
On its own, irrelevant.
If you expect someone looking at the doc string for function `foo' to go to the
doc string of function `bar' to get part of `foo's description, then provide a
link from foo's doc to bar's, and make clear that the parameters correspond etc.
> 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.
Does it say that that is a description of NO-RECURSIVE-EDIT? No.
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.
A user should be able to scan or search the doc string for a parameter name, to
find its description (especially when the doc string is long, as in this case).
> > 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:
Irrelevant. Which part of "doc string" is not clear? By "self-documenting
editor", Emacs does not mean only that you can find some comments that might
help in the source code. Emacs promises more than that.
next prev parent reply other threads:[~2013-04-29 13:42 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
2013-04-29 13:42 ` Drew Adams [this message]
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=9457FCDD57DC456A9526E04663C0009C@us.oracle.com \
--to=drew.adams@oracle.com \
--cc=13923@debbugs.gnu.org \
--cc=juri@jurta.org \
/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).