From 2a438cc4eb3e0721c739bb3dc3665f0348ebd402 Mon Sep 17 00:00:00 2001
From: Stefano Azzalini <73150750+stfnzl@users.noreply.github.com>
Date: Sat, 11 May 2024 10:07:09 +0200
Subject: [PATCH] Document um.skip (#5852)

Add docblock

Co-authored-by: Stefano <stefano@burken.lan>
---
 src/undo_manager/index.ts | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/undo_manager/index.ts b/src/undo_manager/index.ts
index 2328cef42..450555772 100644
--- a/src/undo_manager/index.ts
+++ b/src/undo_manager/index.ts
@@ -321,6 +321,14 @@ export default class UndoManagerModule extends Module<UndoManagerConfig & { name
     return result;
   }
 
+  /**
+   * Execute the provided callback temporarily stopping tracking changes
+   * @param clb The callback to execute with changes tracking stopped
+   * @example
+   * um.skip(() => {
+   *  // Do stuff without tracking
+   * });
+   */
   skip(clb: Function) {
     const isTracking = !!this.um.isTracking();