[tepl] Utils: better document the str truncate functions



commit 55d1582d4b874f0c289e2dc19c12f5fdca4472e0
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Mon Nov 4 15:20:46 2019 +0100

    Utils: better document the str truncate functions

 tepl/tepl-utils.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
---
diff --git a/tepl/tepl-utils.c b/tepl/tepl-utils.c
index a59ae8c..5e7705f 100644
--- a/tepl/tepl-utils.c
+++ b/tepl/tepl-utils.c
@@ -96,8 +96,8 @@ str_truncate (const gchar *string,
 /**
  * tepl_utils_str_middle_truncate:
  * @str: a UTF-8 string.
- * @truncate_length: maximum length allowed for @str, in UTF-8 characters (not
- *   bytes).
+ * @truncate_length: truncate the string at that length, in UTF-8 characters
+ *   (not bytes).
  *
  * If @str is longer than @truncate_length, then this function returns @str
  * truncated in the middle with a “…” character. Otherwise it just returns a
@@ -116,8 +116,8 @@ tepl_utils_str_middle_truncate (const gchar *str,
 /**
  * tepl_utils_str_end_truncate:
  * @str: a UTF-8 string.
- * @truncate_length: maximum length allowed for @str, in UTF-8 characters (not
- *   bytes).
+ * @truncate_length: truncate the string at that length, in UTF-8 characters
+ *   (not bytes).
  *
  * Like tepl_utils_str_middle_truncate() but the “…” character is at the end.
  *


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]