Add docstrings skeletons.

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

diff --git a/aces_1.0.0/python/aces_ocio/createSonyColorSpaces.py b/aces_1.0.0/python/aces_ocio/createSonyColorSpaces.py
index 2352e58..a7eaef1 100644 (file)
--- a/aces_1.0.0/python/aces_ocio/createSonyColorSpaces.py
+++ b/aces_1.0.0/python/aces_ocio/createSonyColorSpaces.py
@@ -6,10 +6,34 @@ import array
 import aces_ocio.generateLUT as genlut
 from aces_ocio.util import ColorSpace, mat44FromMat33
 
-#
-# SLog to ACES
-#
+__author__ = 'ACES Developers'
+__copyright__ = 'Copyright (C) 2014 - 2015 - ACES Developers'
+__license__ = ''
+__maintainer__ = 'ACES Developers'
+__email__ = 'aces@oscars.org'
+__status__ = 'Production'
+
+__all__ = ['createSlog',
+           'createColorSpaces']
+
+
 def createSlog(gamut, transferFunction, name, lutDir, lutResolution1d):
+    """
+    Object description.
+
+    SLog to ACES.
+
+    Parameters
+    ----------
+    parameter : type
+        Parameter description.
+
+    Returns
+    -------
+    type
+         Return value description.
+    """
+
     name = "%s - %s" % (transferFunction, gamut)
     if transferFunction == "":
         name = "Linear - %s" % gamut
@@ -180,6 +204,20 @@ def createSlog(gamut, transferFunction, name, lutDir, lutResolution1d):
 
 
 def createColorSpaces(lutDir, lutResolution1d):
+    """
+    Generates the colorspace conversions.
+
+    Parameters
+    ----------
+    parameter : type
+        Parameter description.
+
+    Returns
+    -------
+    type
+         Return value description.
+    """
+
     colorspaces = []
 
     # SLog1