Document Reedline::echo_on

nushell · Dec 20, 2023 · 56cf8e2 · 56cf8e2
1 parent 518a8db
commit 56cf8e2
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/src/engine.rs b/src/engine.rs
@@ -149,7 +149,14 @@ pub struct Reedline {
     // Manage optional kitty protocol
     kitty_protocol: KittyProtocolGuard,
 
-    // Echo typed input
+    /// Whether to echo typed input
+    ///
+    /// On unix systems, this corresponds to the
+    /// [termios](https://www.man7.org/linux/man-pages/man3/termios.3.html) `ECHO` flag.
+    /// If it is set by the terminal, typed characters will be printed.
+    /// Otherwise, typed characters are not shown.
+    ///
+    /// On non-unix systems this will always remain `true`.
     echo_on: bool,
 
     #[cfg(feature = "external_printer")]