]> granicus.if.org Git - python/commitdiff
Updated docstring.
authorBarry Warsaw <barry@python.org>
Fri, 2 Oct 1998 16:01:42 +0000 (16:01 +0000)
committerBarry Warsaw <barry@python.org>
Fri, 2 Oct 1998 16:01:42 +0000 (16:01 +0000)
Tools/pynche/ColorDB.py

index ed7f6b1aee7908bda5088db6df5b46d54f035d56..effed55651049bc235b125141a0789d3672b4a37 100644 (file)
@@ -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