unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Lars Ingebrigtsen <larsi@gnus.org>
Cc: acm@muc.de, 42776@debbugs.gnu.org
Subject: bug#42776: Obscure documentation of `edebug-form-data' in edebug.el
Date: Sat, 26 Dec 2020 11:01:36 +0200	[thread overview]
Message-ID: <83k0t5lz4f.fsf@gnu.org> (raw)
In-Reply-To: <87k0tr3xtb.fsf@gnus.org> (message from Lars Ingebrigtsen on Wed,  09 Dec 2020 14:37:20 +0100)

> From: Lars Ingebrigtsen <larsi@gnus.org>
> Date: Wed, 09 Dec 2020 14:37:20 +0100
> Cc: 42776@debbugs.gnu.org
> 
> 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"?

"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.





  reply	other threads:[~2020-12-26  9:01 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
2020-12-26  9:01   ` Eli Zaretskii [this message]
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=83k0t5lz4f.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=42776@debbugs.gnu.org \
    --cc=acm@muc.de \
    --cc=larsi@gnus.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).