Clarify addMutations documentation

2024-05-31 14:24:53 -07:00
parent 5da76e4585
commit 169afd629c
1 changed files with 3 additions and 2 deletions
--- 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);