diff options
| author | Eli Zaretskii | 2018-06-16 14:00:47 +0300 |
|---|---|---|
| committer | Eli Zaretskii | 2018-06-16 14:00:47 +0300 |
| commit | 63ba73a9f2bdf75363eea678a8c119ed0ffd9799 (patch) | |
| tree | 2982e7f2d75a24eee8ea9ee9f458d167d43ed633 | |
| parent | 22aa665c9b536775a28ff2e4907afc31b69ccb21 (diff) | |
| download | emacs-63ba73a9f2bdf75363eea678a8c119ed0ffd9799.tar.gz emacs-63ba73a9f2bdf75363eea678a8c119ed0ffd9799.zip | |
Fix documentation of ':propertize' in mode-line-format
* doc/lispref/modes.texi (Mode Line Data): Make the description of
':propertize' more accurate. (Bug#26291)
| -rw-r--r-- | doc/lispref/modes.texi | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi index 8a77745d8f7..d7e217c5287 100644 --- a/doc/lispref/modes.texi +++ b/doc/lispref/modes.texi | |||
| @@ -1839,10 +1839,13 @@ recursion. | |||
| 1839 | 1839 | ||
| 1840 | @item (:propertize @var{elt} @var{props}@dots{}) | 1840 | @item (:propertize @var{elt} @var{props}@dots{}) |
| 1841 | A list whose first element is the symbol @code{:propertize} says to | 1841 | A list whose first element is the symbol @code{:propertize} says to |
| 1842 | process the mode line construct @var{elt} recursively, then add the text | 1842 | process the mode line construct @var{elt} recursively, then add the |
| 1843 | properties specified by @var{props} to the result. The argument | 1843 | text properties specified by @var{props} to the result. The argument |
| 1844 | @var{props} should consist of zero or more pairs @var{text-property} | 1844 | @var{props} should consist of zero or more pairs @var{text-property} |
| 1845 | @var{value}. | 1845 | @var{value}. If @var{elt} is or produces a string with text |
| 1846 | properties, all the characters of that string should have the same | ||
| 1847 | properties, or else some of them might be removed by | ||
| 1848 | @code{:propertize}. | ||
| 1846 | 1849 | ||
| 1847 | @item (@var{symbol} @var{then} @var{else}) | 1850 | @item (@var{symbol} @var{then} @var{else}) |
| 1848 | A list whose first element is a symbol that is not a keyword specifies | 1851 | A list whose first element is a symbol that is not a keyword specifies |