1
0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2025-01-23 18:47:57 +00:00

Improve 'describe-char-fold-equivalences' docstring

* lisp/char-fold.el (describe-char-fold-equivalences): Explain what
the output looks like.
This commit is contained in:
Robert Pluim 2023-01-10 15:22:34 +01:00
parent fda1ad4a9e
commit 64fe6bdb61

View File

@ -436,7 +436,23 @@ specify the character). With no input, i.e. when CHAR is nil,
describe all available character equivalences of `char-fold-to-regexp'.
Optional argument LAX (interactively, the prefix argument), if
non-nil, means also include partially matching ligatures and
non-canonical equivalences."
non-canonical equivalences.
Each line of the display shows the equivalences in two different
ways separated by a colon:
- as the literal character or sequence
- using an ASCII-only escape syntax
For example, for the letter \\='r\\=', the first line is
r: ?\\N{LATIN SMALL LETTER R}
which is for the requested character itself, and a later line has
ṟ: ?\\N{LATIN SMALL LETTER R}?\\N{COMBINING MACRON BELOW}
which clearly shows what the constituent characters are."
(interactive (list (ignore-errors
(read-char-by-name
(format-prompt "Unicode name, single char, or hex"