From e40c6bfccfbb6bac63ac14cdf9d0b7c63f6a89e1 Mon Sep 17 00:00:00 2001
From: JonathanStarup <32037926+JonathanStarup@users.noreply.github.com>
Date: Sun, 30 Oct 2022 16:00:42 +0100
Subject: [PATCH] docs about `saveCursor`

---
 src/Terminal.flix | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/Terminal.flix b/src/Terminal.flix
index 9777de7..70c17e2 100644
--- a/src/Terminal.flix
+++ b/src/Terminal.flix
@@ -97,6 +97,8 @@ namespace Terminal {
 
     ///
     /// Saves the current cursor position for later restoration.
+    /// OBS: Note that this position does not account for terminal scrolling
+    /// when printing newlines at the bottom of the terminal.
     ///
     pub def saveCursor(): Unit \ IO =
         output(Terminal/String.saveCursor())