From: Lars Ingebrigtsen <larsi@gnus.org>
To: Alan Mackenzie <acm@muc.de>
Cc: 42776@debbugs.gnu.org
Subject: bug#42776: Obscure documentation of `edebug-form-data' in edebug.el
Date: Wed, 09 Dec 2020 14:37:20 +0100 [thread overview]
Message-ID: <87k0tr3xtb.fsf@gnus.org> (raw)
In-Reply-To: <20200809150341.GA26635@ACM> (Alan Mackenzie's message of "Sun, 9 Aug 2020 15:03:41 +0000")
Alan Mackenzie <acm@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
next prev parent reply other threads:[~2020-12-09 13:37 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-08-09 15:03 bug#42776: Obscure documentation of `edebug-form-data' in edebug.el Alan Mackenzie
2020-12-09 13:37 ` Lars Ingebrigtsen [this message]
2020-12-26 9:01 ` Eli Zaretskii
2020-12-26 22:15 ` Lars Ingebrigtsen
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87k0tr3xtb.fsf@gnus.org \
--to=larsi@gnus.org \
--cc=42776@debbugs.gnu.org \
--cc=acm@muc.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.