From 456b8f9c9640a40c08d887b0ceb55027a17d6395 Mon Sep 17 00:00:00 2001 From: Andrew Noyes Date: Thu, 9 May 2024 17:00:32 -0700 Subject: [PATCH] Suggest ignoring versions older than getOldestVersion --- include/VersionedMap.h | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/include/VersionedMap.h b/include/VersionedMap.h index 0f2ad8d..9a759d3 100644 --- a/include/VersionedMap.h +++ b/include/VersionedMap.h @@ -88,9 +88,10 @@ struct VersionedMap { /** Iterates through a canonicalized[1] view of all the mutations * from `oldestVersion` to the iterator's version. There may be mutations from - * versions < `oldestVersion`, but they won't affect the result. It's - * thread-safe to operate on an iterator concurrently with any method of - * `VersionedMap`, as long as it's not invalidated by `setOldestVersion`. + * versions < `oldestVersion`, but they won't affect the result, and can be + * ignored if desired. It's thread-safe to operate on an iterator concurrently + * with any method of `VersionedMap`, as long as it's not invalidated by + * `setOldestVersion`. * @warning must not outlive its `VersionedMap`. * * [1]: Mutations at different versions may be adjacent. This is necessary for