update doc string for appkit

yeatmanlab · Jan 18, 2024 · c88d099 · c88d099
1 parent 6c3a07c
commit c88d099
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/firestore/app/appkit.ts b/src/firestore/app/appkit.ts
@@ -188,6 +188,9 @@ export class RoarAppkit {
    * @param {boolean} markAsUnreliable - Whether or not to mark the run as unreliable, defaults to true
    * @method
    * @async
+   * 
+   * Please note that calling this function with a new set of engagement flags will 
+   * overwrite the previous set. 
    */
   async updateEngagementFlags(flagNames: string[], markAsUnreliable = true) {
     if (this._started) {