GNU bug report logs - #36478
26.2; Doc strings with "This function has a compiler macro..." and "This function does not change global state"

Previous Next

Full log

Message #32 received at 36478 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 36478 <at> debbugs.gnu.org
Subject: Re: 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

Drew Adams <drew.adams <at> 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

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.