summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorErik Rose <erik@mozilla.com>2011-12-09 19:05:36 -0500
committerErik Rose <erik@mozilla.com>2011-12-09 19:05:46 -0500
commita06790b3b9e017d08ea194b3737be7a2c864592c (patch)
treec488a00157549a619fd4144cd2c6ee66b689da0d
parent15293bc24d35d4c60dbce75528bde571c1a60b63 (diff)
downloadblessings-a06790b3b9e017d08ea194b3737be7a2c864592c.tar.gz
Correct the description of what happens when an unsupported color is used.
-rw-r--r--README.rst13
1 files changed, 8 insertions, 5 deletions
diff --git a/README.rst b/README.rst
index 55f91ec..9a16966 100644
--- a/README.rst
+++ b/README.rst
@@ -163,13 +163,12 @@ The available colors are...
* ``cyan``
* ``white``
-As hinted above, there is also a ``bright`` version of each. If your terminal
-does not support the bright palette, it will usually render them as black.
-
You can set the background color instead of the foreground by prepending
-``on_``, as in ``on_blue`` or ``on_bright_white``.
+``on_``, as in ``on_blue``. There is also a ``bright`` version of each color:
+for example, ``on_bright_blue``.
-There is also a numerical interface to colors, which takes integers from 0-15::
+There is also a numerical interface to colors, which takes an integer from
+0-15::
term.color(5) + 'Hello' + term.normal
term.on_color(3) + 'Hello' + term.normal
@@ -177,6 +176,10 @@ There is also a numerical interface to colors, which takes integers from 0-15::
term.color(5)('Hello')
term.on_color(3)('Hello')
+If some color is unsupported (for instance, if only the normal colors are
+available, not the bright ones), trying to use it will, on most terminals, have
+no effect: the foreground and background colors will stay as they were.
+
Compound Formatting
-------------------