Clarify that SetSize resizes the terminal buffer.

the-mikedavis · Jun 30, 2022 · 6456856 · 6456856
1 parent 2115571
commit 6456856
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/examples/is_tty.rs b/examples/is_tty.rs
@@ -1,7 +1,11 @@
-use crossterm::tty::IsTty;
-use std::io::stdin;
+use crossterm::{tty::IsTty, terminal::{size, SetSize}, execute};
+use std::io::{stdin, stdout};
 
 pub fn main() {
+    println!("{:?}", size().unwrap());
+    execute!(stdout(), SetSize(10, 10)).unwrap();
+    println!("{:?}", size().unwrap());
+
     if stdin().is_tty() {
         println!("Is TTY");
     } else {

diff --git a/src/terminal.rs b/src/terminal.rs
@@ -338,7 +338,7 @@ impl Command for Clear {
     }
 }
 
-/// A command that sets the terminal size `(columns, rows)`.
+/// A command that sets the terminal buffer size `(columns, rows)`.
 ///
 /// # Notes
 ///
-Original file line number
+Diff line change
@@ Expand Up / @@ -338,7 +338,7 @@ impl Command for Clear { @@
         }
     }
-    /// A command that sets the terminal size `(columns, rows)`.
+    /// A command that sets the terminal buffer size `(columns, rows)`.
     ///
     /// # Notes
     ///
@@ Expand Down @@