From 596d144b679420bbbb2beb9633e11eb33d27b3aa Mon Sep 17 00:00:00 2001
From: Stefano <stefano@burken.lan>
Date: Wed, 1 May 2024 08:30:34 +0200
Subject: [PATCH] Add docblock

---
 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 2328cef42e..4505557729 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();