docs: Fix g_strescape rendering escape sequences

In the gi-docgen Markdown flavour, \' will just prevent the apostrophe
from turning into a curly single quote.
This commit is contained in:
Jan Tojnar 2024-05-18 22:53:39 +02:00
parent c88cbd06de
commit 275330009a

View File

@ -2188,11 +2188,11 @@ out:
* @source: a string to escape
* @exceptions: (nullable): a string of characters not to escape in @source
*
* Escapes the special characters '\b', '\f', '\n', '\r', '\t', '\v', '\'
* and '"' in the string @source by inserting a '\' before
* Escapes the special characters `\b`, `\f`, `\n`, `\r`, `\t`, `\v`, `\`
* and `"` in the string @source by inserting a `\` before
* them. Additionally all characters in the range 0x01-0x1F (everything
* below SPACE) and in the range 0x7F-0xFF (all non-ASCII chars) are
* replaced with a '\' followed by their octal representation.
* replaced with a `\` followed by their octal representation.
* Characters supplied in @exceptions are not escaped.
*
* [func@GLib.strcompress] does the reverse conversion.