From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Lars Ingebrigtsen Newsgroups: gmane.emacs.bugs Subject: bug#42776: Obscure documentation of `edebug-form-data' in edebug.el Date: Wed, 09 Dec 2020 14:37:20 +0100 Message-ID: <87k0tr3xtb.fsf@gnus.org> References: <20200809150341.GA26635@ACM> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="21479"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux) Cc: 42776@debbugs.gnu.org To: Alan Mackenzie Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Wed Dec 09 14:38:09 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 1kmzfV-0005VF-FZ for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 09 Dec 2020 14:38:09 +0100 Original-Received: from localhost ([::1]:54552 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kmzfU-0001vQ-He for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 09 Dec 2020 08:38:08 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:59354) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kmzfO-0001vI-6A for bug-gnu-emacs@gnu.org; Wed, 09 Dec 2020 08:38:02 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]:49761) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1kmzfN-00032f-SC for bug-gnu-emacs@gnu.org; Wed, 09 Dec 2020 08:38:01 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1kmzfN-0007E2-QK for bug-gnu-emacs@gnu.org; Wed, 09 Dec 2020 08:38:01 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Lars Ingebrigtsen Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 09 Dec 2020 13:38: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.160752105227735 (code B ref 42776); Wed, 09 Dec 2020 13:38:01 +0000 Original-Received: (at 42776) by debbugs.gnu.org; 9 Dec 2020 13:37:32 +0000 Original-Received: from localhost ([127.0.0.1]:33074 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1kmzet-0007DH-Vh for submit@debbugs.gnu.org; Wed, 09 Dec 2020 08:37:32 -0500 Original-Received: from quimby.gnus.org ([95.216.78.240]:37698) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1kmzer-0007D1-OO for 42776@debbugs.gnu.org; Wed, 09 Dec 2020 08:37:30 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnus.org; s=20200322; h=Content-Type:MIME-Version:Message-ID:In-Reply-To:Date: References:Subject:Cc:To:From:Sender:Reply-To:Content-Transfer-Encoding: Content-ID:Content-Description:Resent-Date:Resent-From:Resent-Sender: Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=SKdm504aUbEuRrSIQRAIg5nqFmBKhJz+yWmWD/RTBfU=; b=e7KeQ6Jn129FRAJKFcz2qlT4CV H1dHKkG3es7Rxtcbd/n49+1b0+Wh+yn59p3kTrId9kC9QAwIaJ3fHmAoh4GR9YQiNrk3qU6L3BTB1 EigJSdV7Q4ym61FY2QFqQxhDSMZSNJxGE6h69c7hBdEzrF4cxjXa7QdyoHaHag6ICiM8=; Original-Received: from cm-84.212.202.86.getinternet.no ([84.212.202.86] helo=xo) by quimby.gnus.org with esmtpsa (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1kmzej-0001Y0-FL; Wed, 09 Dec 2020 14:37:24 +0100 X-Now-Playing: Sibusile Xaba's _Ngiwu Shawbada_: "Elihle" In-Reply-To: <20200809150341.GA26635@ACM> (Alan Mackenzie's message of "Sun, 9 Aug 2020 15:03:41 +0000") 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:195496 Archived-At: 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"? > 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