summaryrefslogtreecommitdiffstats
path: root/termcolor
diff options
context:
space:
mode:
authorBalaji Sivaraman <balaji@balajisivaraman.com>2018-02-20 17:41:25 +0530
committerAndrew Gallant <jamslam@gmail.com>2018-02-20 07:11:25 -0500
commitc78ab9e66970803e17a688990e3c30722d9c97cc (patch)
tree36a5de029efa15afd05e2b8f430f5d8ba559da6e /termcolor
parentd57fc580818e655e7b0edca2924e259bd5dc02d2 (diff)
termcolor: improve "intense" docs
Fixes #797
Diffstat (limited to 'termcolor')
-rw-r--r--termcolor/src/lib.rs14
1 files changed, 14 insertions, 0 deletions
diff --git a/termcolor/src/lib.rs b/termcolor/src/lib.rs
index f1c36cbe..7b90851a 100644
--- a/termcolor/src/lib.rs
+++ b/termcolor/src/lib.rs
@@ -1269,9 +1269,23 @@ impl ColorSpec {
}
/// Get whether this is intense or not.
+ ///
+ /// On Unix-like systems, this will output the ANSI escape sequence
+ /// that will print a high-intensity version of the color
+ /// specified.
+ ///
+ /// On Windows systems, this will output the ANSI escape sequence
+ /// that will print a brighter version of the color specified.
pub fn intense(&self) -> bool { self.intense }
/// Set whether the text is intense or not.
+ ///
+ /// On Unix-like systems, this will output the ANSI escape sequence
+ /// that will print a high-intensity version of the color
+ /// specified.
+ ///
+ /// On Windows systems, this will output the ANSI escape sequence
+ /// that will print a brighter version of the color specified.
pub fn set_intense(&mut self, yes: bool) -> &mut ColorSpec {
self.intense = yes;
self