diff --git a/src/lib.rs b/src/lib.rs index 8753f31..487c85e 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -29,7 +29,7 @@ //! //! * Functions can execute commands on types that implement Write. Functions are easier to use and debug. //! There is a disadvantage, and that is that there is a boilerplate code involved. -//! * Macros are generally seen as more difficult but offer an API with less boilerplate code. If you are +//! * Macros are generally seen as more difficult and aren't always well supported by editors but offer an API with less boilerplate code. If you are //! not afraid of macros, this is a recommendation. //! //! Linux and Windows 10 systems support ANSI escape codes. Those ANSI escape codes are strings or rather a @@ -39,7 +39,7 @@ //! ### Supported Commands //! //! - Module `cursor` -//! - Visibility - [`Show`](cursor/struct.Show.html), [`Hide`](cursor/struct.Show.html) +//! - Visibility - [`Show`](cursor/struct.Show.html), [`Hide`](cursor/struct.Hide.html) //! - Appearance - [`EnableBlinking`](cursor/struct.EnableBlinking.html), //! [`DisableBlinking`](cursor/struct.DisableBlinking.html) //! - Position - @@ -235,7 +235,7 @@ pub use utils::{Command, ErrorKind, ExecutableCommand, Output, QueueableCommand, pub mod cursor; /// A module to read events. pub mod event; -/// A module to work with the terminal screen. +/// A module to work with the terminal screen and modes. pub mod screen; /// A module to apply attributes and colors on your text. pub mod style; diff --git a/src/utils/command.rs b/src/utils/command.rs index 7905f31..490241c 100644 --- a/src/utils/command.rs +++ b/src/utils/command.rs @@ -28,14 +28,14 @@ pub trait Command { fn execute_winapi(&self) -> Result<()>; } -/// A trait that defines behaviour for a command that can be used to be executed at a later time point. +/// A trait that defines behaviour for a command which can be executed at a later time. /// This can be used in order to get more performance. pub trait QueueableCommand: Sized { /// Queues the given command for later execution. fn queue(&mut self, command: impl Command) -> Result<&mut Self>; } -/// A trait that defines behaviour for a command that will be executed immediately. +/// A trait that defines behaviour for a command which will be executed immediately. pub trait ExecutableCommand: Sized { /// Execute the given command directly. fn execute(&mut self, command: impl Command) -> Result<&mut Self>;