summaryrefslogtreecommitdiffstats
path: root/Lib/colorsys.py
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>1999-02-25 14:24:22 (GMT)
committerFred Drake <fdrake@acm.org>1999-02-25 14:24:22 (GMT)
commit87209172f0c7b672c2662f75664de7b07edcb802 (patch)
tree443c1e6b87082ddadb87ec67a4f0345f619c28b7 /Lib/colorsys.py
parent51027c4173520fc04eca3caf3a6d866354709728 (diff)
downloadcpython-87209172f0c7b672c2662f75664de7b07edcb802.zip
cpython-87209172f0c7b672c2662f75664de7b07edcb802.tar.gz
cpython-87209172f0c7b672c2662f75664de7b07edcb802.tar.bz2
Adjusted comment at the top to be less confusing, following Fredrik
Lundh's example. Converted comment to docstring.
Diffstat (limited to 'Lib/colorsys.py')
-rw-r--r--Lib/colorsys.py30
1 files changed, 16 insertions, 14 deletions
diff --git a/Lib/colorsys.py b/Lib/colorsys.py
index c48b2cb..dd6865c 100644
--- a/Lib/colorsys.py
+++ b/Lib/colorsys.py
@@ -1,17 +1,19 @@
-# Conversion functions between RGB and other color systems.
-#
-# Define two functions for each color system XYZ:
-# rgb_to_xyz(r, g, b) --> x, y, z
-# xyz_to_rgb(x, y, z) --> r, g, b
-# All inputs and outputs are triples of floats in the range [0.0...1.0].
-# Inputs outside this range may cause exceptions or invalid outputs.
-#
-# Supported color systems:
-# RGB: Red, Green, Blue components
-# YIQ: used by composite video signals
-# HLS: Hue, Luminance, S???
-# HSV: Hue, Saturation, Value(?)
-#
+"""Conversion functions between RGB and other color systems.
+
+This modules provides two functions for each color system ABC:
+
+ rgb_to_abc(r, g, b) --> a, b, c
+ abc_to_rgb(x, y, z) --> r, g, b
+
+All inputs and outputs are triples of floats in the range [0.0...1.0].
+Inputs outside this range may cause exceptions or invalid outputs.
+
+Supported color systems:
+RGB: Red, Green, Blue components
+YIQ: used by composite video signals
+HLS: Hue, Luminance, S???
+HSV: Hue, Saturation, Value(?)
+"""
# References:
# XXX Where's the literature?