Merge pull request #1919 from xtermjs/Tyriar-patch-1

Improve docs on Terminal.resize
xtermjs · Jan 31, 2019 · 8e88ce8 · 8e88ce8
2 parents 93d3842 + 828f14f
commit 8e88ce8
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/typings/xterm.d.ts b/typings/xterm.d.ts
@@ -443,7 +443,9 @@ declare module 'xterm' {
     addDisposableListener(type: string, handler: (...args: any[]) => void): IDisposable;
 
     /**
-     * Resizes the terminal.
+     * Resizes the terminal. It's best practice to debounce calls to resize,
+     * this will help ensure that the pty can respond to the resize event
+     * before another one occurs.
      * @param x The number of columns to resize to.
      * @param y The number of rows to resize to.
      */