From: Alan Mackenzie <acm@muc.de>
To: 42776@debbugs.gnu.org
Subject: bug#42776: Obscure documentation of `edebug-form-data' in edebug.el
Date: Sun, 9 Aug 2020 15:03:41 +0000 [thread overview]
Message-ID: <20200809150341.GA26635@ACM> (raw)
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).
next reply other threads:[~2020-08-09 15:03 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-08-09 15:03 Alan Mackenzie [this message]
2020-12-09 13:37 ` bug#42776: Obscure documentation of `edebug-form-data' in edebug.el Lars Ingebrigtsen
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
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200809150341.GA26635@ACM \
--to=acm@muc.de \
--cc=42776@debbugs.gnu.org \
/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 public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).