From 5122fdc441e247b330003db559d5754f701ed97c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=B6rg=20Breitbart?= <jerch@rockborn.de>
Date: Mon, 8 Jul 2019 00:53:13 +0200
Subject: [PATCH] document wonky usage of Terminal.reset

---
 src/Terminal.ts | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/src/Terminal.ts b/src/Terminal.ts
index d40d622f..c2b79ea3 100644
--- a/src/Terminal.ts
+++ b/src/Terminal.ts
@@ -1824,7 +1824,12 @@ export class Terminal extends Disposable implements ITerminal, IDisposable, IInp
   }
 
   /**
-   * Full reset of the terminal.
+   * Reset terminal.
+   * Note: Calling this directly from JS is synchronous but does not clear
+   * input buffers and does not reset the parser, thus the terminal will
+   * continue to apply pending input data.
+   * If you need in band reset (synchronous with input data) consider
+   * using DECSTR (soft reset, CSI ! p) or RIS instead (hard reset, ESC c).
    */
   public reset(): void {
     /**