From 828f14f2abd58f42497903e745fbfc0af02c34bd Mon Sep 17 00:00:00 2001
From: Daniel Imms <tyriar@tyriar.com>
Date: Thu, 31 Jan 2019 14:00:39 -0800
Subject: [PATCH] Improve docs on Terminal.resize

---
 typings/xterm.d.ts | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/typings/xterm.d.ts b/typings/xterm.d.ts
index dc9ebbae43..d813bc5f7b 100644
--- 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.
      */