Re: Incorporate package macrostep into Emacs core

[Jeremy Bryant]

Eli Zaretskii <eliz@gnu.org> writes:

>> From: Jeremy Bryant <jb@jeremybryant.net>
>> Cc: monnier@iro.umontreal.ca,  emacs-devel@gnu.org
>> Date: Thu, 25 Apr 2024 22:27:56 +0100
>> 
>> Absolutely, sorry, attached is the revised patch I have worked on.
>
> Thanks, a few minor comments below.
>
>> Subject: [PATCH] Add Macrostep section in manual
>> 
>> Macrostep is an Emacs Lisp macro-expander useful for exploring and
>> writing macros.  This is based on Jonathan's Oddie's documentation
>> in the macrostep package.
>> 
>>      * doc/emacs/programs.texi (Programs): Add Macrostep section.
>>      * doc/emacs/emacs.texi (Top):   Add detailed menu reference.
>  ^^^^^^^                             ^^^
> Those TABs should not be there in the commit log message.
>
>> +You can use @code{macrostep-mode} to explore Lisp macro definitions, and
>> +help write new macros, using @kbd{M-x macrostep-expand} when point is
>> +over a macro.
>
> We say "when point is in a macro".  "Over" is reserved for mouse
> pointer.
>
>> +@kbd{macrostep} is a minor mode for interactively stepping through the
>         ^^^^^^^^^
> "macrostep-mode", I guess?  And why @kbd? is that something the user
> is supposed to type?
>
>> +The standard keybindings in @code{macrostep-mode} are the following:
>> +@table @kbd
>> +@item e
>> +@itemx =
>> +@itemx RET
>> +@findex macrostep-expand
>
> Please move the index entries to _before_ the corresponding @item's,
> so that following the index entry lands you on the @item, not after
> it.
>
> Otherwise, this LGTM, thanks.

OK - Attached is a revised patch incorporating the ideas above (as well as a
refinement from Eshel on clarifying this is for Emacs Lisp).

0001-Add-Macrostep-section-in-manual.patch
Description: Text Data