[glib: 6/8] Extend the documentation of g_sequence_get_length()




commit 4c1b068657c15817df07171dc06ae46bbddea071
Author: Emmanuel Fleury <emmanuel fleury gmail com>
Date:   Tue Nov 17 12:44:46 2020 +0100

    Extend the documentation of g_sequence_get_length()
    
    The return value of g_sequence_get_length() is always a
    positive number.

 glib/gsequence.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
---
diff --git a/glib/gsequence.c b/glib/gsequence.c
index 96f21d6e4..9d76dbb22 100644
--- a/glib/gsequence.c
+++ b/glib/gsequence.c
@@ -1255,9 +1255,9 @@ g_sequence_set (GSequenceIter *iter,
  * g_sequence_get_length:
  * @seq: a #GSequence
  *
- * Returns the length of @seq. Note that this method is O(h) where `h' is the
- * height of the tree. It is thus more efficient to use g_sequence_is_empty()
- * when comparing the length to zero.
+ * Returns the positive length (>= 0) of @seq. Note that this method is
+ * O(h) where `h' is the height of the tree. It is thus more efficient
+ * to use g_sequence_is_empty() when comparing the length to zero.
  *
  * Returns: the length of @seq
  *


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