substitute-command-keys now marks escaped charsscratch/quote-escaping

* doc/lispref/help.texi (Keys in Documentation), etc/NEWS:
Document this.
* src/doc.c (Fsubstitute_command_keys):
Give escaped characters the 'escaped' text property.

1 files changed, 5 insertions, 0 deletions

diff --git a/doc/lispref/help.texi b/doc/lispref/help.texi
index 868d2843569..be4a6f7bc19 100644
--- a/doc/lispref/help.texi
+++ b/doc/lispref/help.texi
@@ -333,6 +333,11 @@ replaces them by what they stand for, returning the result as a string.
 This permits display of documentation that refers accurately to the
 user's own customized key bindings.
 
+In the returned string, replacement characters that should not be
+further transformed have the text property @code{escaped}.  For
+example, when @samp{\=`} is replaced by @samp{`} in the output, the
+replacement character has the text property @code{escaped}.
+
 @cindex advertised binding
 If a command has multiple bindings, this function normally uses the
 first one it finds.  You can specify one particular key binding by