From: Bastien <bastienguerry@googlemail.com>
To: "Drew Adams" <drew.adams@oracle.com>
Cc: emacs-pretest-bug@gnu.org, 3936@emacsbugs.donarmstrong.com
Subject: bug#3936: 23.0.96; doc string of called-interactively-p
Date: Mon, 27 Jul 2009 14:43:36 +0800 [thread overview]
Message-ID: <87r5w2lj6v.fsf@bzg.ath.cx> (raw)
In-Reply-To: <B7C45DCE3B4B4510B0A9D8E3BA41AEF1@us.oracle.com> (Drew Adams's message of "Sun, 26 Jul 2009 23:24:03 -0700")
"Drew Adams" <drew.adams@oracle.com> writes:
>> > "Return t if the function using this was called with
>> > `call-interactively'."
>>
>> I replaced this by :
>>
>> Return t if it is in a function called with `call-interactively'.
>
> That's just as bad.
Thanks. :)
> What's "it"?
Usually "it" in a docstring refers to the function/variable the
docstring is documenting. At least this is how I understand it.
> I really don't understand what you are trying to say.
Are you sure? Even the name of this function is very explicit:
"call-interactively-p", and I bet you know what it does - so it
shouldn't be hard to guess what the docstring is trying to say.
> When does `called-interactively-p' return t?
When the function in which (call-interactively-p) is has been
interactively called with (call-interactively ...)
> It should be possible to describe that
> condition. What does the code say?
Please suggest something better - with this small annoying constraints
that the first line has to be quite short.
--
Bastien
next prev parent reply other threads:[~2009-07-27 6:43 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <877hx4n3r0.fsf@cyd.mit.edu>
2009-07-26 20:56 ` bug#3936: 23.0.96; doc string of called-interactively-p Drew Adams
2009-07-27 2:03 ` Bastien
2009-07-27 6:24 ` Drew Adams
2009-07-27 6:43 ` Bastien [this message]
2009-07-27 8:18 ` Drew Adams
2009-07-27 9:17 ` Bastien
2009-07-27 16:04 ` Drew Adams
2009-08-15 22:00 ` bug#3936: marked as done (23.0.96; doc string of called-interactively-p) Emacs bug Tracking System
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87r5w2lj6v.fsf@bzg.ath.cx \
--to=bastienguerry@googlemail.com \
--cc=3936@emacsbugs.donarmstrong.com \
--cc=drew.adams@oracle.com \
--cc=emacs-pretest-bug@gnu.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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.