]> git.eshelyaron.com Git - emacs.git/commitdiff
; Improve documentation of 'minibuffer-allow-text-properties'
authorEli Zaretskii <eliz@gnu.org>
Fri, 8 Mar 2024 13:06:37 +0000 (15:06 +0200)
committerEshel Yaron <me@eshelyaron.com>
Mon, 11 Mar 2024 09:20:41 +0000 (10:20 +0100)
* doc/lispref/minibuf.texi (Text from Minibuffer): Document the
default value of 'minibuffer-allow-text-properties'.

(cherry picked from commit b9f7a2274f6a8352085d01c15bf9086ffe25f437)

doc/lispref/minibuf.texi

index 70f2b679399fc8bea8711425477011c934ca54ae..59f63ed7901056db8960833d557ad1f302af5a52 100644 (file)
@@ -187,7 +187,8 @@ History}.
 If the variable @code{minibuffer-allow-text-properties} is
 non-@code{nil}, then the string that is returned includes whatever text
 properties were present in the minibuffer.  Otherwise all the text
-properties are stripped when the value is returned.
+properties are stripped when the value is returned.  (By default this
+variable is @code{nil}.)
 
 @vindex minibuffer-prompt-properties
 The text properties in @code{minibuffer-prompt-properties} are applied
@@ -350,11 +351,12 @@ See @code{read-regexp} above for details of how these values are used.
 @end defopt
 
 @defvar minibuffer-allow-text-properties
-If this variable is @code{nil}, then @code{read-from-minibuffer} strip
-all text properties from the minibuffer input before returning it.
-Otherwise, the minibuffer input is returned as is, along with its text
-properties.  Moreover, if this variable is non-@code{nil}, most text
-properties on strings from the completion table are preserved as well.
+If this variable is @code{nil}, the default, then
+@code{read-from-minibuffer} strips all text properties from the
+minibuffer input before returning it.  Otherwise, the minibuffer input
+is returned as is, along with its text properties.  Moreover, if this
+variable is non-@code{nil}, most text properties on strings from the
+completion table are preserved as well.
 
 @lisp
 (let ((minibuffer-allow-text-properties t))