bug#69745: [PATCH] Fix incorrect Edebug docstrings

[Eli Zaretskii <eliz@gnu.org>]

> 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.