From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#42776: Obscure documentation of `edebug-form-data' in edebug.el Date: Sat, 26 Dec 2020 11:01:36 +0200 Message-ID: <83k0t5lz4f.fsf@gnu.org> References: <20200809150341.GA26635@ACM> <87k0tr3xtb.fsf@gnus.org> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="3584"; mail-complaints-to="usenet@ciao.gmane.io" Cc: acm@muc.de, 42776@debbugs.gnu.org To: Lars Ingebrigtsen Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sat Dec 26 10:02:14 2020 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1kt5Sn-0000oh-9d for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 26 Dec 2020 10:02:13 +0100 Original-Received: from localhost ([::1]:36568 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kt5Sm-0008R7-CK for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 26 Dec 2020 04:02:12 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:37870) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kt5Sc-0008R1-C6 for bug-gnu-emacs@gnu.org; Sat, 26 Dec 2020 04:02:02 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]:47165) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1kt5Sc-0007Nk-2s for bug-gnu-emacs@gnu.org; Sat, 26 Dec 2020 04:02:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1kt5Sb-0002Ja-Vv for bug-gnu-emacs@gnu.org; Sat, 26 Dec 2020 04:02:01 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 26 Dec 2020 09:02:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 42776 X-GNU-PR-Package: emacs Original-Received: via spool by 42776-submit@debbugs.gnu.org id=B42776.16089733198890 (code B ref 42776); Sat, 26 Dec 2020 09:02:01 +0000 Original-Received: (at 42776) by debbugs.gnu.org; 26 Dec 2020 09:01:59 +0000 Original-Received: from localhost ([127.0.0.1]:58711 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1kt5SZ-0002JK-JS for submit@debbugs.gnu.org; Sat, 26 Dec 2020 04:01:59 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:44696) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1kt5SX-0002J7-Gq for 42776@debbugs.gnu.org; Sat, 26 Dec 2020 04:01:58 -0500 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:58214) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kt5SS-0007Jf-3R; Sat, 26 Dec 2020 04:01:52 -0500 Original-Received: from 84.94.185.95.cable.012.net.il ([84.94.185.95]:1195 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1kt5SR-0007R7-Fo; Sat, 26 Dec 2020 04:01:51 -0500 In-Reply-To: <87k0tr3xtb.fsf@gnus.org> (message from Lars Ingebrigtsen on Wed, 09 Dec 2020 14:37:20 +0100) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.io gmane.emacs.bugs:196753 Archived-At: > From: Lars Ingebrigtsen > Date: Wed, 09 Dec 2020 14:37:20 +0100 > Cc: 42776@debbugs.gnu.org > > Alan Mackenzie 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.