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#69745: [PATCH] Fix incorrect Edebug docstrings Date: Sat, 16 Mar 2024 12:43:40 +0200 Message-ID: <868r2i78yr.fsf@gnu.org> References: <18e31efc662.110b51b75233014.2760074093528628525@excalamus.com> <18e43236053.ea8d2a62434521.1358079795129399231@excalamus.com> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="2966"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 69745-done@debbugs.gnu.org, schwab@suse.de To: Matt Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sat Mar 16 11:44:55 2024 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 1rlRX5-0000Zb-05 for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 16 Mar 2024 11:44:55 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rlRWi-0005CM-Qq; Sat, 16 Mar 2024 06:44:32 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rlRWb-000582-Oj for bug-gnu-emacs@gnu.org; Sat, 16 Mar 2024 06:44:25 -0400 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1rlRWb-0003yI-CA for bug-gnu-emacs@gnu.org; Sat, 16 Mar 2024 06:44:25 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1rlRXB-0006SC-Sf for bug-gnu-emacs@gnu.org; Sat, 16 Mar 2024 06:45:01 -0400 Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-To: bug-gnu-emacs@gnu.org Resent-Date: Sat, 16 Mar 2024 10:45:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: cc-closed 69745 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Mail-Followup-To: 69745@debbugs.gnu.org, eliz@gnu.org, matt@excalamus.com Original-Received: via spool by 69745-done@debbugs.gnu.org id=D69745.171058586924731 (code D ref 69745); Sat, 16 Mar 2024 10:45:01 +0000 Original-Received: (at 69745-done) by debbugs.gnu.org; 16 Mar 2024 10:44:29 +0000 Original-Received: from localhost ([127.0.0.1]:54911 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rlRWf-0006Qo-5B for submit@debbugs.gnu.org; Sat, 16 Mar 2024 06:44:29 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:58892) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rlRWc-0006QT-Vq for 69745-done@debbugs.gnu.org; Sat, 16 Mar 2024 06:44:27 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rlRVw-0003Yv-5u; Sat, 16 Mar 2024 06:43:44 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=MIME-version:References:Subject:In-Reply-To:To:From: Date; bh=abpzncYOcKqjVSK9e+o5OToBR0qjvLxLWS/izowvLOs=; b=NN/zIoStzUH6Dzoz7s9X mtzggnNX0o3dzVtYAeq9T+28DtXWFnvNdr3eDiciHTeF+VGDmiQGMIhQWtekWkH83zwxvXz7WJgTh TLvjdrpST+2CnVIvrQlyyuTpRQWzqLP4OJ9eF14njzQ0QlCAIZsYpwdwPLil18YpueqJYCESwbxa3 vw4OwdodS5VBc1L18rYZ5uczKa0IG732V1xIQ5doBHbkSsIpJsFPHdVZ45kwf220qdeN38h+tHmh9 RD7wEoJ9qjIUuCClrsQIHl6wXRM88nKfL70y3a8FRZoldTCBAx5l6c1knAmqWJYy82jDZ+LkNSeX4 YSMzb5B61mJl6A==; In-Reply-To: <18e43236053.ea8d2a62434521.1358079795129399231@excalamus.com> (message from Matt on Fri, 15 Mar 2024 18:22:55 +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-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:281717 Archived-At: > Cc: 69745 <69745@debbugs.gnu.org> > Date: Fri, 15 Mar 2024 18:22:55 +0100 > From: Matt > > Thanks for taking the time to review this. > > You are correct in the functioning. The problem is the current docstrings are ambiguous. Consider the current description for 'edebug-print-length': > > "If non-nil, default value of ‘print-length’ for printing results in Edebug." > > This has, at least, two possible interpretations: > > 1. "If non-nil, USE THE VALUE OF EDEBUG-PRINT-LENGTH FOR THE default value of 'print-length' for printing results in Edebug." > 2. "If non-nil, USE THE default value of 'print-length' for printing results in Edebug." > > As you point out, the first meaning is the intended one based on the implementation. I read it according to the second interpretation. > > Without getting hung up on why it's ambiguous, I hope I've made the case that it is ambiguous. > > I've updated the patch to use the same wording as 'print-length' and 'print-level' which hopefully makes things clear. The current docstring felt it necessary to explicitly mention "for printing results in Edebug" and I've tried to preserve that in the suggested changes. Thanks, I installed a variant of this on the emacs-29 branch, and I'm therefore closing this bug.