GNU bug report logs - #77124
[PATCH] Optionally display function docstring in eldoc

Previous Next

Full log

View this message in rfc822 format

From: Elijah Gabe Pérez <eg642616 <at> gmail.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 77124 <at> debbugs.gnu.org
Subject: bug#77124: [PATCH] Optionally display function docstring in eldoc
Date: Sat, 29 Mar 2025 13:35:18 -0600

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

Eli Zaretskii <eliz <at> gnu.org> writes:

>> From: Elijah Gabe Pérez <eg642616 <at> gmail.com>
>> Cc: 77124 <at> debbugs.gnu.org
>> Date: Thu, 20 Mar 2025 12:37:23 -0600

>> --- a/etc/NEWS
>> +++ b/etc/NEWS
>> @@ -1900,6 +1900,17 @@ another pattern matching syntax that is different from that of 'pcase',
>>  which some users might find less cryptic.
>>  See the Info node "(elisp) cond* Macro" for details.

>> +---
>> +** New eldoc function 'elisp-eldoc-funcall-with-docstring'.
>> +This function includes the current function docstring in eldoc echo area
>> +and can be used as a more detailed alternative to 'elisp-eldoc-funcall'.
>> +
>> +** New user option 'elisp-eldoc-funcall-with-docstring-lenght'.
>> +This user option specifies how long function docstring must be displayed
>> +in 'elisp-eldoc-funcall-with-docstring'.  If set to 'short' only display
>> +cut docstring before period.  Otherwise if set to 'full', display full
>> +docstring.'

> These two entries should be moved to a separate section "ElDoc" under
> "Changes in Specialized Modes and Packages in Emacs 31.1".

> Also, please mark the second entry with "---", and fix a typo there
> ("length").



>> +(defcustom elisp-eldoc-funcall-with-docstring-lenght 'short
>> +  "Specify function docstring lenght in `elisp-eldoc-funcall-with-docstring'.

> "Control length of doc string shown by `elisp-eldoc-funcall-with-docstring'."

> (Note the typo: "length".)

>> +If set to `short' only display docstring before period.,
>                     ^
> A comma is missing there.  Also, there's a redundant comma at the end.
> And I would rephrase:

>   If set to `short', only show the first sentence of the doc string.

Done.

[Message part 2 (text/html, inline)]

[0001-Optionally-display-function-docstring-in-eldoc.patch (text/x-patch, attachment)]

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

-- 
                                          - E.G via GNU Emacs and Org.

Previous Next

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