From 169afd629c3ad244bcde5db99aa9c2a3301cd863 Mon Sep 17 00:00:00 2001 From: Andrew Noyes Date: Fri, 31 May 2024 14:24:53 -0700 Subject: [PATCH] Clarify addMutations documentation --- include/VersionedMap.h | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/include/VersionedMap.h b/include/VersionedMap.h index ca5707f..df1aa73 100644 --- a/include/VersionedMap.h +++ b/include/VersionedMap.h @@ -66,8 +66,9 @@ struct __attribute__((__visibility__("default"))) VersionedMap { MutationType type; }; - /** Mutations must be sorted, non-overlapping, and non-adjacent. `version` - * must be strictly increasing. Postcondition: `getVersion()` == `version` */ + /** Mutations must be sorted, non-overlapping, and clears must be + * non-adjacent. `version` must be strictly increasing. Postcondition: + * `getVersion()` == `version` */ void addMutations(const Mutation *mutations, int numMutations, int64_t version);