Add module headers doctoring skeletons.

[OpenColorIO-Configs.git] / aces_1.0.0 / python / aces_ocio / createCanonColorSpaces.py

diff --git a/aces_1.0.0/python/aces_ocio/createCanonColorSpaces.py b/aces_1.0.0/python/aces_ocio/createCanonColorSpaces.py
index 6a1bf3a..7b5210b 100644 (file)
--- a/aces_1.0.0/python/aces_ocio/createCanonColorSpaces.py
+++ b/aces_1.0.0/python/aces_ocio/createCanonColorSpaces.py
@@ -1,15 +1,43 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
+"""
+Implements support for *Canon* colorspaces conversions and transfer functions.
+"""
+
 import array
 
 import aces_ocio.generateLUT as genlut
 from aces_ocio.util import ColorSpace
 
-#
-# Canon-Log to ACES
-#
+__author__ = 'ACES Developers'
+__copyright__ = 'Copyright (C) 2014 - 2015 - ACES Developers'
+__license__ = ''
+__maintainer__ = 'ACES Developers'
+__email__ = 'aces@oscars.org'
+__status__ = 'Production'
+
+__all__ = ['createCanonLog',
+           'createColorSpaces']
+
+
 def createCanonLog(gamut, transferFunction, name, lutDir, lutResolution1d):
+    """
+    Object description.
+
+    Canon-Log to ACES.
+
+    Parameters
+    ----------
+    parameter : type
+        Parameter description.
+
+    Returns
+    -------
+    type
+         Return value description.
+    """
+
     name = "%s - %s" % (transferFunction, gamut)
     if transferFunction == "":
         name = "Linear - %s" % gamut
@@ -118,8 +146,21 @@ def createCanonLog(gamut, transferFunction, name, lutDir, lutResolution1d):
     return cs
 
 
-# Generate all color spaces conversion
 def createColorSpaces(lutDir, lutResolution1d):
+    """
+    Generates the colorspace conversions.
+
+    Parameters
+    ----------
+    parameter : type
+        Parameter description.
+
+    Returns
+    -------
+    type
+         Return value description.
+    """
+
     colorspaces = []
 
     # Full conversion