From 56cf8e2e7bc384c4cd39eb2045ce0d9d7a0fdaa9 Mon Sep 17 00:00:00 2001
From: Ian Manske <ian.manske@pm.me>
Date: Wed, 20 Dec 2023 17:52:14 -0500
Subject: [PATCH] Document `Reedline::echo_on`

---
 src/engine.rs | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/src/engine.rs b/src/engine.rs
index b97feb4c..0ed808fa 100644
--- 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")]