From: Fred Drake <fdrake@acm.org>
Date: Thu, 25 Feb 1999 14:24:22 +0000 (+0000)
Subject: Adjusted comment at the top to be less confusing, following Fredrik
X-Git-Tag: v1.5.2c1~248
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=87209172f0c7b672c2662f75664de7b07edcb802;p=python

Adjusted comment at the top to be less confusing, following Fredrik
Lundh's example.

Converted comment to docstring.
---

diff --git a/Lib/colorsys.py b/Lib/colorsys.py
index c48b2cbc30..dd6865cbe0 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?