unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Stefan Monnier <monnier@iro.umontreal.ca>
Cc: emacs-devel@gnu.org
Subject: Re: master 48ac40e60e: ; Fix last change.
Date: Sun, 14 Aug 2022 21:31:38 +0300	[thread overview]
Message-ID: <8335dyk779.fsf@gnu.org> (raw)
In-Reply-To: <jwvtu6elmxx.fsf-monnier+emacs@gnu.org> (message from Stefan Monnier on Sun, 14 Aug 2022 14:16:02 -0400)

> From: Stefan Monnier <monnier@iro.umontreal.ca>
> Cc: emacs-devel@gnu.org
> Date: Sun, 14 Aug 2022 14:16:02 -0400
> 
> > +This returns non-nil if its argument is either a built-in, or a
> > +byte-compiled, or a natively-compiled function object, or a function
> > +loaded from a dynamic module.
> 
> Funny: I find this rather hard to understand compared to my
> original wording.  E.g. a reader might wonder what other cases there
> could be and why they don't return non-nil.

Are there other cases?  If so, what are they?  If I know what they
are, I can think of a better wording.

But if there are no other cases, I see nothing wrong with the current
wording.

> IOW, I prefer an "intentional" description over the "extensional" one
> you installed.

The original wording was too vague.  Such a specific API cannot be
documented in such vague terms.

> E.g. it's more useful when faced with a new function type.

Whoever does that change will need to remember to update the
documentation.  If they don't, some future bug report will remind us.

We cannot refrain from documenting useful things because we don't want
to have top modify our documentation due to future changes.



  reply	other threads:[~2022-08-14 18:31 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <166049949398.16955.13217655219158269477@vcs2.savannah.gnu.org>
     [not found] ` <20220814175134.47827C09BFD@vcs2.savannah.gnu.org>
2022-08-14 18:16   ` master 48ac40e60e: ; Fix last change Stefan Monnier
2022-08-14 18:31     ` Eli Zaretskii [this message]
2022-08-14 18:42       ` Stefan Monnier
2022-08-14 18:46         ` Eli Zaretskii
2022-08-14 18:56           ` Lars Ingebrigtsen
2022-08-14 19:15             ` Eli Zaretskii
2022-08-14 19:23               ` Lars Ingebrigtsen
2022-08-15  2:23                 ` Eli Zaretskii
2022-08-15  4:30                   ` Lars Ingebrigtsen
2022-08-15 11:30                     ` Eli Zaretskii
2022-08-15  2:37           ` Stefan Monnier
2022-08-15 11:20             ` Eli Zaretskii

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=8335dyk779.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=emacs-devel@gnu.org \
    --cc=monnier@iro.umontreal.ca \
    /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).