summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBarry Warsaw <barry@python.org>1998-10-02 16:01:42 (GMT)
committerBarry Warsaw <barry@python.org>1998-10-02 16:01:42 (GMT)
commita9053f65ded955481c641e0ce80e8a7d5154d63e (patch)
tree531af5b3c7f487403d3d8fe26a0d4a3cfa7fe7d2
parent9f3ea211dd91968ddde9e3ed25cde755ac27fe2c (diff)
downloadcpython-a9053f65ded955481c641e0ce80e8a7d5154d63e.zip
cpython-a9053f65ded955481c641e0ce80e8a7d5154d63e.tar.gz
cpython-a9053f65ded955481c641e0ce80e8a7d5154d63e.tar.bz2
Updated docstring.
-rw-r--r--Tools/pynche/ColorDB.py17
1 files changed, 12 insertions, 5 deletions
diff --git a/Tools/pynche/ColorDB.py b/Tools/pynche/ColorDB.py
index ed7f6b1..effed55 100644
--- a/Tools/pynche/ColorDB.py
+++ b/Tools/pynche/ColorDB.py
@@ -1,16 +1,23 @@
"""Color Database.
-To create a class that contains color lookup methods, use the module global
-function `get_colordb(file)'. This function will try to examine the file to
-figure out what the format of the file is. If it can't figure out the file
-format, or it has trouble reading the file, None is returned. You can pass
-get_colordb() an optional filetype argument.
+This file contains one class, called ColorDB, and several utility functions.
+The class must be instantiated by the get_colordb() function in this file,
+passing it a filename to read a database out of.
+
+The get_colordb() function will try to examine the file to figure out what the
+format of the file is. If it can't figure out the file format, or it has
+trouble reading the file, None is returned. You can pass get_colordb() an
+optional filetype argument.
Supporte file types are:
X_RGB_TXT -- X Consortium rgb.txt format files. Three columns of numbers
from 0 .. 255 separated by whitespace. Arbitrary trailing
columns used as the color name.
+
+The utility functions are useful for converting between the various expected
+color formats, and for calculating other color values.
+
"""
import sys