Subject: bug#77124: [PATCH] Optionally display function docstring in eldoc

From: Eli Zaretskii <[email-masked]>
Date: Thu, 20 Mar 2025 14:25:45 +0200

> From: Elijah Gabe Pérez <[email-masked]>
> 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?

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

> +If set to nil do not show function docstring."
> +  :type '(choice
> +          (const :tag "None")
> +          (const :tag "Short" short)
> +          (const :tag "Full" full))
> +  :group 'elisp)

The :version tag is missing.

Thanks.

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