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

Previous Next

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: tracker <at> debbugs.gnu.org
Subject: bug#77124: closed ([PATCH] Optionally display function docstring
 in eldoc)
Date: Sat, 05 Apr 2025 09:19:02 +0000

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

Your message dated Sat, 05 Apr 2025 12:18:07 +0300
with message-id <86wmbzvueo.fsf <at> gnu.org>
and subject line Re: bug#77124: [PATCH] Optionally display function docstring in eldoc
has caused the debbugs.gnu.org bug report #77124,
regarding [PATCH] Optionally display function docstring in eldoc
to be marked as done.

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


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

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

From: Elijah Gabe Pérez <eg642616 <at> gmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: [PATCH] Optionally display function docstring in eldoc
Date: Wed, 19 Mar 2025 12:32:15 -0600

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

Tags: patch

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.

In GNU Emacs 31.0.50 (build 1, x86_64-redhat-linux-gnu, GTK+ Version
 3.24.43, cairo version 1.18.2) of 2025-03-18 built on
 0dae0d7b05b64c3db75f27d2c3f0cd33
System Description: Fedora Linux 41 (Workstation Edition)

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

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

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

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

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Elijah Gabe Pérez <eg642616 <at> gmail.com>
Cc: 77124-done <at> debbugs.gnu.org
Subject: Re: bug#77124: [PATCH] Optionally display function docstring in eldoc
Date: Sat, 05 Apr 2025 12:18:07 +0300

> From: Elijah Gabe Pérez <eg642616 <at> gmail.com>
> Cc: 77124 <at> debbugs.gnu.org
> Date: Sat, 29 Mar 2025 13:35:18 -0600
> 
> 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.

Thanks, installed on the master branch, and closing the bug.

Previous Next

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