From: Štěpán Němec <stepnem@gmail.com>
Date: Thu, 26 May 2022 08:58:22 +0000 (+0200)
Subject: ; Fix up doc of recent elisp-eldoc-var-docstring-with-value addition
X-Git-Tag: emacs-29.0.90~1910^2~418
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=47e0b866110b25343daf025de85d5f22ed829cc1;p=emacs.git

; Fix up doc of recent elisp-eldoc-var-docstring-with-value addition
---

diff --git a/etc/NEWS b/etc/NEWS
index 0f59d545e37..4ebaf6e07ad 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -1873,6 +1873,8 @@ functions.
 
 ---
 ** New eldoc function: 'elisp-eldoc-var-docstring-with-value'.
+This function includes the current value of the variable in eldoc display
+and can be used as a more detailed alternative to 'elisp-eldoc-var-docstring'.
 
 ** 'save-some-buffers' can now be extended to save other things.
 Traditionally, 'save-some-buffers' saved buffers, and also saved
diff --git a/lisp/progmodes/elisp-mode.el b/lisp/progmodes/elisp-mode.el
index 84b7938bf0d..77bf3f1ed18 100644
--- a/lisp/progmodes/elisp-mode.el
+++ b/lisp/progmodes/elisp-mode.el
@@ -1775,7 +1775,8 @@ Also see `elisp-eldoc-var-docstring-with-value'."
 (defun elisp-eldoc-var-docstring-with-value (callback &rest _)
   "Document variable at point.
 Intended for `eldoc-documentation-functions' (which see).
-Also see `elisp-eldoc-var-docstring-with-value'."
+Compared to `elisp-eldoc-var-docstring', this also includes the
+current variable value and a bigger chunk of the docstring."
   (when-let ((cs (elisp--current-symbol)))
     (when (and (boundp cs)
 	       ;; nil and t are boundp!