Improve RootSet documentation

2024-05-03 16:39:30 -07:00
parent 971aabea6e
commit 58a50e2056
1 changed files with 2 additions and 1 deletions
--- a/RootSet.h
+++ b/RootSet.h
@@ -15,7 +15,8 @@ struct RootSet {

  /// Foreign threads may freely interact with a `ThreadSafeHandle`, as long as
  /// the latest version as of obtaining the handle is greater than
-  /// `oldestVersion`.
+  /// `oldestVersion`, and they only read versions >= `oldestVersion` and <= the
+  /// version as of obtaining the handle.
  struct ThreadSafeHandle {

    /// Get a root node that can correctly be used for `version`