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

Previous Next

Full log

Message #13 received at 77124 <at> debbugs.gnu.org (full text, mbox):

From: Elijah Gabe Pérez <eg642616 <at> gmail.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 77124 <at> debbugs.gnu.org
Subject: Re: bug#77124: [PATCH] Optionally display function docstring in eldoc
Date: Thu, 20 Mar 2025 12:37:23 -0600

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

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

>> From: Elijah Gabe Pérez <eg642616 <at> gmail.com>
>> Date: Wed, 19 Mar 2025 12:32:15 -0600

>> This user option tell whether 'eldoc' should display elisp function docstring.
>> If set to 'short' only display a short docstring, otherwise if set to
>> 'full', display full docstring.
>> If set to nil do not show function docstring.

> Where will the doc string be shown?

> If in the echo-area, then what will happen when eldoc shows the info
> on the mode line instead?

I've fixed it to only show in the echo-area and not to mode-line.

Also I've moved it to a function instead modifying existing ones,
similar to ~elisp-eldoc-var-docstring-with-value~.

>> +(defcustom elisp-eldoc-show-function-docstring nil
>> +  "Show function docstring in `eldoc-mode'.
>> +If set to `short' only display a short docstring, otherwise if set to
>> +`full', display full docstring.

> This should explain what is the "short docstring".  Also, where the
> documentation is shown.

I've added it.

To explain:
Instead display this full docstring:

  Set each SYM to the value of its VAL.

  The symbols SYM are variables; they are literal (not evaluated).
  The values VAL are expressions; they are evaluated.
  Thus, (setq x (1+ y)) sets x to the value of (1+ y).
  The second VAL is not computed until after the first SYM is set, and so on;
  each VAL can use the new value of variables set earlier in the setq.
  The return value of the setq form is the value of the last VAL.

Only display it like this:

  Set each SYM to the value of its VAL.

> P.S. For the next version of the patch, please remember mentioning the
> bug number in the commit log message.

Sure.

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