procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

; Improve documentation of 'minibuffer-allow-text-properties'

Browse source 
* doc/lispref/minibuf.texi (Text from Minibuffer): Document the
default value of 'minibuffer-allow-text-properties'.
This commit is contained in:
Eli Zaretskii 2024-03-08 15:06:37 +02:00
parent 5ffcca121b
commit b9f7a2274f
1 changed files with 8 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
doc/lispref/minibuf.texi
View 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,14 +351,15 @@ 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}
and @code{read-string} strip all text properties from the minibuffer
input before returning it. However,
If this variable is @code{nil}, the default, then
@code{read-from-minibuffer} and @code{read-string} strip all text
properties from the minibuffer input before returning it. However,
@code{read-no-blanks-input} (see below), as well as
@code{read-minibuffer} and related functions (@pxref{Object from
Minibuffer,, Reading Lisp Objects With the Minibuffer}), and all
functions that do minibuffer input with completion, remove the @code{face}
property unconditionally, regardless of the value of this variable.
functions that do minibuffer input with completion, remove the
@code{face} property unconditionally, regardless of the value of this
variable.
If this variable is non-@code{nil}, most text properties on strings
from the completion table are preserved---but only on the part of the