From 7d1d424c8a510953fc4bb9c8d2449951b81f0762 Mon Sep 17 00:00:00 2001 From: Ticki Date: Wed, 16 Mar 2016 08:52:09 +0100 Subject: [PATCH] Small doc fixes --- src/async.rs | 2 +- src/color.rs | 2 +- src/control.rs | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/async.rs b/src/async.rs index 05f424c..f833f96 100644 --- a/src/async.rs +++ b/src/async.rs @@ -9,7 +9,7 @@ use std::thread; /// be buffered in a mpsc queue, which will eventually be read by the current thread. /// /// Note that this will acquire the Mutex lock on the standard input, making all future stdin -/// construction hang the program. +/// construction hang the program until the reader is dropped. pub fn async_stdin() -> AsyncReader { let (send, recv) = mpsc::channel(); diff --git a/src/color.rs b/src/color.rs index 35dec2b..256fe89 100644 --- a/src/color.rs +++ b/src/color.rs @@ -35,7 +35,7 @@ pub enum Color { LightWhite, /// 216-color (r, g, b ≤ 5) RGB. Rgb(u8, u8, u8), - /// Grayscale (max value: 24) + /// Grayscale (max value: 24). Grayscale(u8), } diff --git a/src/control.rs b/src/control.rs index 57211e5..9781e69 100644 --- a/src/control.rs +++ b/src/control.rs @@ -93,7 +93,7 @@ pub trait TermWrite { b'm', ]) } - /// Set foreground color + /// Set foreground color. fn color(&mut self, color: Color) -> io::Result { let ansi = color.to_ansi_val(); self.csi(&[ @@ -108,7 +108,7 @@ pub trait TermWrite { b'm', ]) } - /// Set background color + /// Set background color. fn bg_color(&mut self, color: Color) -> io::Result { let ansi = color.to_ansi_val(); self.csi(&[