Add comment with rationale for having format_text_chr().

From fa1027a004.
This commit is contained in:
João Valverde 2021-11-29 21:02:20 +00:00
parent c6e6f21685
commit 13783fae6b
1 changed files with 2 additions and 1 deletions

View File

@ -828,7 +828,8 @@ format_text_wsp(wmem_allocator_t* allocator, const guchar *string, size_t len)
*
* This does *not* treat the input string as UTF-8.
*
* XXX - is there any reason to use this?
* This is useful for displaying binary data that frequently but not always
* contains text; otherwise the number of C escape codes makes it unreadable.
*/
gchar *
format_text_chr(wmem_allocator_t* allocator, const guchar *string, const size_t len, const guchar chr)