Add module headers doctoring 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 604777c..51be98f 100644 (file)
--- a/aces_1.0.0/python/aces_ocio/createSonyColorSpaces.py
+++ b/aces_1.0.0/python/aces_ocio/createSonyColorSpaces.py
@@ -1,6 +1,10 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
+"""
+Implements support for *Sony* colorspaces conversions and transfer functions.
+"""
+
 import array
 
 import aces_ocio.generateLUT as genlut
@@ -16,10 +20,24 @@ __status__ = 'Production'
 __all__ = ['createSlog',
            'createColorSpaces']
 
-#
-# SLog to ACES
-#
+
 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
@@ -190,6 +208,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