Extend the documentation of g_sequence_get_length()

The return value of g_sequence_get_length() is always a
positive number.
This commit is contained in:
Emmanuel Fleury 2020-11-17 12:44:46 +01:00
parent 89729bcd28
commit 4c1b068657

View File

@ -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
*