GNU bug report logs - #42776
Obscure documentation of `edebug-form-data' in edebug.el

Previous Next

Full log

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: acm <at> muc.de, 42776 <at> debbugs.gnu.org
Subject: Re: bug#42776: Obscure documentation of `edebug-form-data' in
 edebug.el
Date: Sat, 26 Dec 2020 11:01:36 +0200

> From: Lars Ingebrigtsen <larsi <at> gnus.org>
> Date: Wed, 09 Dec 2020 14:37:20 +0100
> Cc: 42776 <at> debbugs.gnu.org
> 
> Alan Mackenzie <acm <at> muc.de> writes:
> 
> > The doc string of edebug-form-data begins thusly:
> >
> >      "A list of entries associating symbols with buffer regions.
> >       Each entry is an `edebug--form-data' struct with fields:
> >       SYMBOL, BEGIN-MARKER, and END-MARKER.  The markers
> >       are at the beginning and end of an entry level form and SYMBOL is
> >       a symbol that holds all edebug related information for the form on its
> >       property list."
> >
> > The following extract from this is obscure: "...the beginning and end of
> > an entry level form ...."
> >
> > What in heaven or earth is an "entry level form"?  What is it for?
> 
> I'm guessing that's just a typo for "of a form"?

"Of an instrumented form", I guess?  Any reason not to modify the doc
string with that?

> > Less major questions are: What is the nature of the "association" of the
> > symbols with the buffer regions?  Which buffer gets its regions
> > associated?

The buffer in which the instrumented form lives.  IOW, the source code
of the form you instrumented.

Previous Next

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