GNU bug report logs - #69745
[PATCH] Fix incorrect Edebug docstrings

Previous Next

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Matt <matt <at> excalamus.com>
Subject: bug#69745: closed (Re: bug#69745: [PATCH] Fix incorrect Edebug
 docstrings)
Date: Sat, 16 Mar 2024 10:45:01 +0000

[Message part 1 (text/plain, inline)]

Your bug report

#69745: [PATCH] Fix incorrect Edebug docstrings

which was filed against the emacs package, has been closed.

The explanation is attached below, along with your original report.
If you require more details, please reply to 69745 <at> debbugs.gnu.org.

-- 
69745: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=69745
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems

[Message part 2 (message/rfc822, inline)]

From: Eli Zaretskii <eliz <at> gnu.org>
To: Matt <matt <at> excalamus.com>
Cc: 69745-done <at> debbugs.gnu.org, schwab <at> suse.de
Subject: Re: bug#69745: [PATCH] Fix incorrect Edebug docstrings
Date: Sat, 16 Mar 2024 12:43:40 +0200

> Cc: 69745 <69745 <at> debbugs.gnu.org>
> Date: Fri, 15 Mar 2024 18:22:55 +0100
> From: Matt <matt <at> excalamus.com>
> 
> 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.

[Message part 3 (message/rfc822, inline)]

From: Matt <matt <at> excalamus.com>
To: "bug-gnu-emacs" <bug-gnu-emacs <at> gnu.org>
Subject: [PATCH] Fix incorrect Edebug docstrings
Date: Tue, 12 Mar 2024 10:13:01 +0100

[Message part 4 (text/plain, inline)]

Hi,

When edebug-print-length and edebug-print-level are nil, they default to print-level and print-length.  The docstrings currently say the opposite, that edebug defaults to the print variables if non-nil.

Thank you
--
Matt Trzcinski
Emacs Org contributor (ob-shell)
Learn more about Org mode at https://orgmode.org
Support Org development at https://liberapay.com/org-mode

[fix-incorrect-edebug-docstring.diff (application/octet-stream, attachment)]

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.