Add module headers doctoring skeletons.

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

diff --git a/aces_1.0.0/python/aces_ocio/createARRIColorSpaces.py b/aces_1.0.0/python/aces_ocio/createARRIColorSpaces.py
index 3f5591c..fc4256b 100644 (file)
--- a/aces_1.0.0/python/aces_ocio/createARRIColorSpaces.py
+++ b/aces_1.0.0/python/aces_ocio/createARRIColorSpaces.py
@@ -1,6 +1,10 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
+"""
+Implements support for *ARRI* colorspaces conversions and transfer functions.
+"""
+
 import array
 import math
 
@@ -8,15 +12,39 @@ import aces_ocio.generateLUT as genlut
 from aces_ocio.util import ColorSpace, mat44FromMat33
 
 
-#
-# LogC to ACES
-#
+__author__ = 'ACES Developers'
+__copyright__ = 'Copyright (C) 2014 - 2015 - ACES Developers'
+__license__ = ''
+__maintainer__ = 'ACES Developers'
+__email__ = 'aces@oscars.org'
+__status__ = 'Production'
+
+__all__ = ['createLogC',
+           'createColorSpaces']
+
+
 def createLogC(gamut,
                transferFunction,
                exposureIndex,
                name,
                lutDir,
                lutResolution1d):
+    """
+    Object description.
+
+    LogC to ACES.
+
+    Parameters
+    ----------
+    parameter : type
+        Parameter description.
+
+    Returns
+    -------
+    type
+         Return value description.
+    """
+
     name = "%s (EI%s) - %s" % (transferFunction, exposureIndex, gamut)
     if transferFunction == "":
         name = "Linear - %s" % gamut
@@ -130,6 +158,20 @@ def createLogC(gamut,
 
 
 def createColorSpaces(lutDir, lutResolution1d):
+    """
+    Generates the colorspace conversions.
+
+    Parameters
+    ----------
+    parameter : type
+        Parameter description.
+
+    Returns
+    -------
+    type
+         Return value description.
+    """
+
     colorspaces = []
 
     transferFunction = "V3 LogC"