Re: master 69d1278527: ; Fix some doc strings in elisp-mode.el

[Eli Zaretskii]

> From: Michael Heerdegen <michael_heerdegen@web.de>
> Cc: Eli Zaretskii <eliz@gnu.org>
> Date: Thu, 17 Nov 2022 03:36:48 +0100
> 
> Eli Zaretskii <eliz@gnu.org> writes:
> 
> > branch: master
> > commit 69d1278527f0a883d55b91088c8e1b04d9e07e81
> > Author: Eli Zaretskii <eliz@gnu.org>
> > Commit: Eli Zaretskii <eliz@gnu.org>
> 
> >  (defun eval-defun (edebug-it)
> > -  "Evaluate the top-level form containing point.
> > +  "Evaluate EDEBUG-IT or the top-level form containing point.
> 
> Unless I don't parse this new first sentence wrong (sorry then):
> 
> This is incorrect. EDEBUG-IT is not an expression.  It's the
> prefix argument and causes the top-level form to be instrumented for
> Edebug, instead of evaluating it normally.  Right?

Truth be told, I don't know.  The original doc string was obviously
incomplete, so I completed it as best I understood the code during the
5 sec I could dedicate to this task.  Part of the reason for writing
the text I installed was to prompt "Someone" to help me get our act
together in this case.

Feel free to describe in more detail what the code does with this
argument (ideally, with pointers to the code), and then we can discuss
how to improve the doc string.

Thanks.