# HG changeset patch
# User Mike Becker <universe@uap-core.de>
# Date 1653652934 -7200
# Node ID 8603709932b92abfec202d1965888d5437c76f92
# Parent  9b767b07602c6798428496acdf260aaa4fa4ef58
corrects documentation of iterator behavior

diff -r 9b767b07602c -r 8603709932b9 src/cx/hash_map.h
--- a/src/cx/hash_map.h	Fri May 27 13:25:42 2022 +0200
+++ b/src/cx/hash_map.h	Fri May 27 14:02:14 2022 +0200
@@ -91,9 +91,9 @@
  *
  * If \p buckets is zero, an implementation defined default will be used.
  *
- * @note Iterators provided by this hash map implementation do provide the remove operation, because
- * a remove never causes an immediate rehashing. The iterators are also position-aware in the sense
- * that the index is initialized with zero and incremented when the iterator advances.
+ * @note Iterators provided by this hash map implementation provide the remove operation.
+ * The index value of an iterator is the incremented when the iterator advanced without removal.
+ * In other words, when the iterator is finished, \c index==size .
  *
  * @param allocator the allocator to use
  * @param buckets the initial number of buckets in this hash map