]> git.eshelyaron.com Git - emacs.git/commitdiff
; Fix documentation of register-preview changes
authorEli Zaretskii <eliz@gnu.org>
Sat, 9 Dec 2023 10:02:48 +0000 (12:02 +0200)
committerEli Zaretskii <eliz@gnu.org>
Sat, 9 Dec 2023 10:02:48 +0000 (12:02 +0200)
* etc/NEWS: Fix wording of 'register-use-preview' entry.

* lisp/register.el (register-use-preview): Doc fix.  Add ':version'.

etc/NEWS
lisp/register.el

index 6dd0f9b5e4ea0c2d8eba3506357b4583d2faec9c..60391cfb22e7d37007aee3f70c3107e69e193b34 100644 (file)
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -1176,8 +1176,9 @@ showcases all their customization options.
 
 ---
 ** 'register-preview-delay' is no longer used.
-Register preview is no more delayed.  If you want to disable it, use
-'register-use-preview' instead with a boolean value.
+Register preview is no longer delayed.  If you want to disable the
+preview, customize the new option 'register-use-preview' to the value
+'never'.
 
 +++
 ** 'M-TAB' now invokes 'completion-at-point' also in Text mode.
index ade65b5bdc2376c3ed7425a9ef6f06a4c6bacdc2..fa4bbcf483fa0747d26d45af521f2139eadfaf3c 100644 (file)
@@ -107,17 +107,18 @@ If nil, do not show register previews, unless `help-char' (or a member of
   :type '(repeat string))
 
 (defcustom register-use-preview t
-  "Maybe show register preview.
+  "Whether to show preview of registers.
 
-When set to `t' show a preview buffer with navigation and highlighting.
-When nil show a basic preview buffer and exit minibuffer
-immediately after insertion in minibuffer.
-When set to \\='never behave as above but with no preview buffer at
-all."
+If the value is t, show a preview buffer with navigation and highlighting.
+If the value is nil, show a basic preview buffer and exit minibuffer
+immediately after the register name is inserted into minibuffer.
+If the value is \\='never, behave as for nil, but with no preview buffer
+at all."
   :type '(choice
           (const :tag "Use preview" t)
           (const :tag "Use quick preview" nil)
-          (const :tag "Never use preview" never)))
+          (const :tag "Never use preview" never))
+  :version "30.1")
 
 (defun get-register (register)
   "Return contents of Emacs register named REGISTER, or nil if none."