[glib: 1/2] gutils: Mention NBSP in g_format_size() documentation
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib: 1/2] gutils: Mention NBSP in g_format_size() documentation
- Date: Thu, 10 Jan 2019 15:01:53 +0000 (UTC)
commit f1729119b4c575e4502846b87979b6fc7ce011ca
Author: Philip Withnall <withnall endlessm com>
Date: Thu Jan 10 11:25:36 2019 +0000
gutils: Mention NBSP in g_format_size() documentation
This is a follow-up to
https://gitlab.gnome.org/GNOME/glib/merge_requests/548.
Signed-off-by: Philip Withnall <withnall endlessm com>
Closes #1625
glib/gutils.c | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
---
diff --git a/glib/gutils.c b/glib/gutils.c
index 09c1523a7..f1b203709 100644
--- a/glib/gutils.c
+++ b/glib/gutils.c
@@ -2305,7 +2305,9 @@ g_nullify_pointer (gpointer *nullify_location)
* Formats a size (for example the size of a file) into a human readable
* string. Sizes are rounded to the nearest size prefix (kB, MB, GB)
* and are displayed rounded to the nearest tenth. E.g. the file size
- * 3292528 bytes will be converted into the string "3.2 MB".
+ * 3292528 bytes will be converted into the string "3.2 MB". The returned string
+ * is UTF-8, and may use a non-breaking space to separate the number and units,
+ * to ensure they aren’t separated when line wrapped.
*
* The prefix units base is 1000 (i.e. 1 kB is 1000 bytes).
*
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]