From a7b3d8fe4cd68f2eaa8f7f3b1c6b4418f56f62b0 Mon Sep 17 00:00:00 2001
From: Andrew Noyes <andrew@weaselab.dev>
Date: Tue, 6 Aug 2024 11:29:33 -0700
Subject: [PATCH] Clarify `insert` documentation

---
 ConflictSet.cpp | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/ConflictSet.cpp b/ConflictSet.cpp
index 5abc406..2ed53bb 100644
--- a/ConflictSet.cpp
+++ b/ConflictSet.cpp
@@ -2882,9 +2882,9 @@ checkMaxBetweenExclusiveImpl<true>(Node *n, int begin, int end,
 #endif
 
 // Returns a pointer to the newly inserted node.  Caller must set
-// `entryPresent`, and `entry` fields.  The search path of the result will have
-// `maxVersion` at least `writeVersion` as a postcondition. Nodes along the
-// search path to `key` may be invalidated.
+// `entryPresent`, and `entry` fields.  All nodes along the search path of the
+// result will have `maxVersion` set to `writeVersion` as a postcondition. Nodes
+// along the search path may be invalidated.
 [[nodiscard]] Node *insert(Node **self, std::span<const uint8_t> key,
                            InternalVersionT writeVersion, WriteContext *tls,
                            ConflictSet::Impl *impl) {