From: Barry Warsaw <barry@python.org>
Date: Fri, 2 Oct 1998 15:58:50 +0000 (+0000)
Subject: Added docstring
X-Git-Tag: v1.5.2a2~170
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=ddb9fc1ebd0c019c0c651e4335d6cdfd043ef7c5;p=python

Added docstring
---

diff --git a/Tools/pynche/ChipViewer.py b/Tools/pynche/ChipViewer.py
index 7f9ebc7669..ef70e95c5a 100644
--- a/Tools/pynche/ChipViewer.py
+++ b/Tools/pynche/ChipViewer.py
@@ -1,3 +1,18 @@
+"""Chip viewer and widget.
+
+In the lower left corner of the main Pynche window, you will see two
+ChipWidgets, one for the selected color and one for the nearest color.  The
+selected color is the actual RGB value expressed as an X11 #COLOR name. The
+nearest color is the named color from the X11 database that is closest to the
+selected color in 3D space.  There may be other colors equally close, but the
+nearest one is the first one found.
+
+Clicking on the nearest color chip selects that named color.
+
+The ChipViewer class includes the entire lower left quandrant; i.e. both the
+selected and nearest ChipWidgets.
+"""
+
 from types import StringType
 from Tkinter import *
 import ColorDB