Improve thread-safety documentation

2024-05-02 21:23:46 -07:00
parent eba1c2ce2a
commit 0727a1ebe7
1 changed files with 3 additions and 1 deletions
--- a/include/VersionedMap.h
+++ b/include/VersionedMap.h
@@ -33,7 +33,9 @@ namespace weaselab {
 *   - It's safe to operate on two different VersionedMaps in two different
 * threads concurrently
 *   - It's safe to have multiple threads operating on the same VersionedMap
- * concurrently if and only if all threads only call const methods.
+ * concurrently if all threads only call const methods.
+ *   - Methods that make stronger guarantees about the safety of calling
+ * concurrently with non-const methods are documented as such.
 */
 struct VersionedMap {