GNU bug report logs -
#42776
Obscure documentation of `edebug-form-data' in edebug.el
Previous Next
Reported by: Alan Mackenzie <acm <at> muc.de>
Date: Sun, 9 Aug 2020 15:04:02 UTC
Severity: minor
Tags: fixed
Fixed in version 28.1
Done: Lars Ingebrigtsen <larsi <at> gnus.org>
Bug is archived. No further changes may be made.
To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 42776 in the body.
You can then email your comments to 42776 AT debbugs.gnu.org in the normal way.
Toggle the display of automated, internal messages from the tracker.
Report forwarded
to
bug-gnu-emacs <at> gnu.org
:
bug#42776
; Package
emacs
.
(Sun, 09 Aug 2020 15:04:02 GMT)
Full text and
rfc822 format available.
Acknowledgement sent
to
Alan Mackenzie <acm <at> muc.de>
:
New bug report received and forwarded. Copy sent to
bug-gnu-emacs <at> gnu.org
.
(Sun, 09 Aug 2020 15:04:02 GMT)
Full text and
rfc822 format available.
Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):
Hello, Emacs.
In the master branch:
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?
Less major questions are: What is the nature of the "association" of the
symbols with the buffer regions? Which buffer gets its regions
associated?
It seems the only way to make sense of this doc string is by reading
edebug.el's source to find out what it means. This isn't what doc
strings are supposed to be for.
This is a bug.
--
Alan Mackenzie (Nuremberg, Germany).
Information forwarded
to
bug-gnu-emacs <at> gnu.org
:
bug#42776
; Package
emacs
.
(Wed, 09 Dec 2020 13:38:01 GMT)
Full text and
rfc822 format available.
Message #8 received at 42776 <at> debbugs.gnu.org (full text, mbox):
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"?
> Less major questions are: What is the nature of the "association" of the
> symbols with the buffer regions? Which buffer gets its regions
> associated?
>
> It seems the only way to make sense of this doc string is by reading
> edebug.el's source to find out what it means. This isn't what doc
> strings are supposed to be for.
I'm not extremely familiar with the edebug data structures -- can
somebody clarify this doc string?
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog: http://lars.ingebrigtsen.no
Information forwarded
to
bug-gnu-emacs <at> gnu.org
:
bug#42776
; Package
emacs
.
(Sat, 26 Dec 2020 09:02:01 GMT)
Full text and
rfc822 format available.
Message #11 received at 42776 <at> debbugs.gnu.org (full text, mbox):
> 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.
Information forwarded
to
bug-gnu-emacs <at> gnu.org
:
bug#42776
; Package
emacs
.
(Sat, 26 Dec 2020 22:17:03 GMT)
Full text and
rfc822 format available.
Message #14 received at 42776 <at> debbugs.gnu.org (full text, mbox):
Eli Zaretskii <eliz <at> gnu.org> writes:
> "Of an instrumented form", I guess? Any reason not to modify the doc
> string with that?
Looking at the code, that does seem to be the intended meaning (I
think), so I've now made that change.
>> > 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.
Yup. And I think that's everything covered? So I'm closing this bug report.
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog: http://lars.ingebrigtsen.no
Added tag(s) fixed.
Request was from
Lars Ingebrigtsen <larsi <at> gnus.org>
to
control <at> debbugs.gnu.org
.
(Sat, 26 Dec 2020 22:17:03 GMT)
Full text and
rfc822 format available.
bug marked as fixed in version 28.1, send any further explanations to
42776 <at> debbugs.gnu.org and Alan Mackenzie <acm <at> muc.de>
Request was from
Lars Ingebrigtsen <larsi <at> gnus.org>
to
control <at> debbugs.gnu.org
.
(Sat, 26 Dec 2020 22:17:04 GMT)
Full text and
rfc822 format available.
bug archived.
Request was from
Debbugs Internal Request <help-debbugs <at> gnu.org>
to
internal_control <at> debbugs.gnu.org
.
(Sun, 24 Jan 2021 12:24:06 GMT)
Full text and
rfc822 format available.
This bug report was last modified 3 years and 93 days ago.
Previous Next
GNU bug tracking system
Copyright (C) 1999 Darren O. Benham,
1997,2003 nCipher Corporation Ltd,
1994-97 Ian Jackson.