]> git.eshelyaron.com Git - emacs.git/commitdiff
; Fix up doc of recent elisp-eldoc-var-docstring-with-value addition
authorŠtěpán Němec <stepnem@gmail.com>
Thu, 26 May 2022 08:58:22 +0000 (10:58 +0200)
committerŠtěpán Němec <stepnem@gmail.com>
Thu, 26 May 2022 08:58:22 +0000 (10:58 +0200)
etc/NEWS
lisp/progmodes/elisp-mode.el

index 0f59d545e37830d9610bdd37da78333d8e6fddf5..4ebaf6e07ada3c3173af80315d6bbac1a730adda 100644 (file)
--- 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
index 84b7938bf0db764a5aa4428c50df81e665bd904c..77bf3f1ed181cba88aad3886c1481086cc5889b9 100644 (file)
@@ -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!