unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Lars Ingebrigtsen <larsi@gnus.org>
To: Drew Adams <drew.adams@oracle.com>
Cc: 36478@debbugs.gnu.org
Subject: bug#36478: 26.2; Doc strings with "This function has a compiler macro..." and "This function does not change global state"
Date: Wed, 02 Feb 2022 19:55:47 +0100	[thread overview]
Message-ID: <87o83pp07g.fsf@gnus.org> (raw)
In-Reply-To: <13f5f7df-9017-45a0-986f-8b1a4ee0e9bd@default> (Drew Adams's message of "Tue, 2 Jul 2019 11:05:18 -0700 (PDT)")

Drew Adams <drew.adams@oracle.com> writes:

> `C-h f zerop' tells you this:
>
>  zerop is a compiled Lisp function in 'subr.el'.
>
>  (zerop NUMBER)
>
>  This function has a compiler macro 'zerop--anon-cmacro'.
>
>  Return t if NUMBER is zero.
>  This function does not change global state, including the match data.
>
> Why on earth would we put that info about the function having a compiler
> macro before the first doc string line?

In Emacs 29 these details have been moved to the end of the help buffer.

I've now also added some indexing to the manual so that it's easier to
find out what a "compiler macro" is.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no





  parent reply	other threads:[~2022-02-02 18:55 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-07-02 18:05 bug#36478: 26.2; Doc strings with "This function has a compiler macro..." and "This function does not change global state" Drew Adams
2019-07-02 19:41 ` Eli Zaretskii
2019-07-04  1:34 ` Richard Stallman
2022-02-02 18:55 ` Lars Ingebrigtsen [this message]
     [not found] <<13f5f7df-9017-45a0-986f-8b1a4ee0e9bd@default>
     [not found] ` <<83r278cjho.fsf@gnu.org>
2019-07-02 20:13   ` Drew Adams
2019-07-04  1:35     ` Richard Stallman

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=87o83pp07g.fsf@gnus.org \
    --to=larsi@gnus.org \
    --cc=36478@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).