From 24d0f561e8b5501c18f8e7fd18a60be0624dad68 Mon Sep 17 00:00:00 2001 From: mgunyho Date: Mon, 26 Jul 2021 19:21:21 +0300 Subject: [PATCH] Docs: Add some links related to raw mode (#581) --- src/event.rs | 2 +- src/terminal.rs | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/src/event.rs b/src/event.rs index 3f5571d..37a8826 100644 --- a/src/event.rs +++ b/src/event.rs @@ -15,7 +15,7 @@ //! * use the [`read`](fn.read.html) & [`poll`](fn.poll.html) functions on any, but same, thread //! * or the [`EventStream`](struct.EventStream.html). //! -//! **Make sure to enable raw mode in order for keyboard events to work properly** +//! **Make sure to enable [raw mode](../terminal/#raw-mode) in order for keyboard events to work properly** //! //! ## Mouse Events //! diff --git a/src/terminal.rs b/src/terminal.rs index aa8e7f5..e47f9ed 100644 --- a/src/terminal.rs +++ b/src/terminal.rs @@ -58,6 +58,8 @@ //! - Special keys like backspace and CTL+C will not be processed by terminal driver //! - New line character will not be processed therefore `println!` can't be used, use `write!` instead //! +//! Raw mode can be enabled/disabled with the [enable_raw_mode](terminal::enable_raw_mode) and [disable_raw_mode](terminal::disable_raw_mode) functions. +//! //! ## Examples //! //! ```no_run