summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndre Noll <maan@tuebingen.mpg.de>2026-08-23 20:47:27 +0200
committerAndre Noll <maan@tuebingen.mpg.de>2026-08-23 20:50:40 +0200
commite104b5ed6b936ec85ba700ab74f221d2f963a9f9 (patch)
tree33308523595c2c23ccbb7a0f4f27c471d148eef5
parentf9a397e3f139a8532e2475aff3c8a4bbd47159da (diff)
doc: Improve help text of osl_rbtree_first_row().HEADmaster
Shorten the text, improve its wording and mention that the function fails if the table is empty.
-rw-r--r--osl.h.m47
1 files changed, 3 insertions, 4 deletions
diff --git a/osl.h.m4 b/osl.h.m4
index 1968975..320d9fd 100644
--- a/osl.h.m4
+++ b/osl.h.m4
@@ -505,10 +505,9 @@ DECLARE_FUNCTION(
«struct osl_row **result»,
«A pointer to the first row is returned here»
»,
- «The rbtree node of the smallest object (with respect to the
- corresponding compare function) is selected and the row containing
- this object is returned. It is an error if col_num refers to a column
- without an associated rbtree.
+ «Return a reference to the row whose object in the given column is smallest
+ with respect to the comparator of that column. It is an error if the table
+ is empty or if the given column has no associated red-black tree.
See also: osl_get_nth_row(), osl_rbtree_last_row().»,
«int»,