bug#69745: closed ([PATCH] Fix incorrect Edebug docstrings)

[GNU bug Tracking System]

Your message dated Sat, 16 Mar 2024 12:43:40 +0200
with message-id <868r2i78yr.fsf@gnu.org>
and subject line Re: bug#69745: [PATCH] Fix incorrect Edebug docstrings
has caused the debbugs.gnu.org bug report #69745,
regarding [PATCH] Fix incorrect Edebug docstrings
to be marked as done.

(If you believe you have received this mail in error, please contact
help-debbugs@gnu.org.)


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

--- Begin Message --- Subject: [PATCH] Fix incorrect Edebug docstrings Date: Tue, 12 Mar 2024 10:13:01 +0100 User-agent: Zoho Mail

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
Description: Binary data

--- End Message ---

> --- Begin Message ---
>
>
>
> Subject: 
>
> Re: bug#69745: [PATCH] Fix incorrect Edebug docstrings
>
>
>
>
> Date: 
>
> Sat, 16 Mar 2024 12:43:40 +0200
>
>
>
>
> > Cc: 69745 <69745@debbugs.gnu.org>
> > Date: Fri, 15 Mar 2024 18:22:55 +0100
> > From: Matt <matt@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.
>
>
> --- End Message ---