From 000dba1da525f5575393b5388d6771eb5e43187d Mon Sep 17 00:00:00 2001 From: Patrick Pelissier Date: Sat, 11 May 2024 09:43:20 +0200 Subject: [PATCH] Correct API documentation --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a28e2aa7..a2273c92 100644 --- a/README.md +++ b/README.md @@ -3342,16 +3342,18 @@ or NULL if there is no element in the B+Tree. ##### `void name_it_from(name_it_t it, const name_t tree, const type data)` -Set the iterator `it` to the greatest element of `tree` -lower of equal than `data` or the first element is there is none. +Set the iterator `it` to the lowest element of `tree` +greater or equal than `data` or the end iterator is there is none. ##### `bool name_it_until_p(const name_it_t it, const type data)` -Return true if `it` references an element that is greater or equal than `data`. +Return true if `it` references an element that is greater or equal than `data` +or if it references no longer a valid element, false otherwise. ##### `bool name_it_while_p(const name_it_t it, const type data)` Return true if `it` references an element that is lower or equal than `data`. +Otherwise (or if it references no longer a valid element) it returns false. _________________