From 70a314dd5edd3eeadf3593ef37b908993db3e801 Mon Sep 17 00:00:00 2001
From: Thomas Mansencal <thomas.mansencal@gmail.com>
Date: Thu, 15 Jan 2015 21:13:18 +0100
Subject: [PATCH] Add module headers doctoring skeletons.

---
 aces_1.0.0/python/aces_ocio/__init__.py            |   61 ++++++++++++++++++++
 .../python/aces_ocio/createARRIColorSpaces.py      |    4 ++
 .../python/aces_ocio/createCanonColorSpaces.py     |    4 ++
 .../python/aces_ocio/createREDColorSpaces.py       |    4 ++
 .../python/aces_ocio/createSonyColorSpaces.py      |    4 ++
 aces_1.0.0/python/aces_ocio/create_aces_config.py  |   36 +-----------
 aces_1.0.0/python/aces_ocio/generateLUT.py         |   23 +-------
 aces_1.0.0/python/aces_ocio/process.py             |    4 +-
 aces_1.0.0/python/aces_ocio/util.py                |    4 ++
 9 files changed, 86 insertions(+), 58 deletions(-)

diff --git a/aces_1.0.0/python/aces_ocio/__init__.py b/aces_1.0.0/python/aces_ocio/__init__.py
index 40635b6..b05b81a 100644
--- a/aces_1.0.0/python/aces_ocio/__init__.py
+++ b/aces_1.0.0/python/aces_ocio/__init__.py
@@ -1,6 +1,67 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
+"""
+ACES OCIO
+=========
+
+Usage
+-----
+
+Python
+******
+
+>>> import sys
+>>> sys.path.append("/path/to/script")
+>>> import create_aces_config as cac
+>>> acesReleaseCTLDir = "/path/to/github/checkout/releases/v0.7.1/transforms/ctl"
+>>> configDir = "/path/to/config/dir"
+>>> cac.createACESConfig(acesReleaseCTLDir, configDir, 1024, 33, True)
+
+Command Line
+************
+
+From the directory with 'create_aces_config.py':
+
+$ python create_aces_config.py -a "/path/to/github/checkout/releases/v0.7.1/transforms/ctl" -c "/path/to/config/dir" --lutResolution1d 1024 --lutResolution3d 33 --keepTempImages
+
+Build
+-----
+
+Mac OS X - Required packages
+****************************
+
+OpenColorIO
+___________
+
+$ brew install -vd opencolorio --with-python
+
+OpenImageIO
+___________
+
+$ brew tap homebrew/science
+
+Optional Dependencies
+_____________________
+
+$ brew install -vd libRaw
+$ brew install -vd OpenCV
+$ brew install -vd openimageio --with-python
+
+CTL
+___
+
+$ brew install -vd CTL
+
+OpenColorIO
+___________
+
+*ociolutimage* will build with *openimageio* installed.
+
+$ brew uninstall -vd opencolorio
+$ brew install -vd opencolorio --with-python
+"""
+
 __author__ = 'ACES Developers'
 __copyright__ = 'Copyright (C) 2014 - 2015 - ACES Developers'
 __license__ = ''
diff --git a/aces_1.0.0/python/aces_ocio/createARRIColorSpaces.py b/aces_1.0.0/python/aces_ocio/createARRIColorSpaces.py
index d7d195f..fc4256b 100644
--- 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
 
diff --git a/aces_1.0.0/python/aces_ocio/createCanonColorSpaces.py b/aces_1.0.0/python/aces_ocio/createCanonColorSpaces.py
index 9b8d92c..7b5210b 100644
--- a/aces_1.0.0/python/aces_ocio/createCanonColorSpaces.py
+++ b/aces_1.0.0/python/aces_ocio/createCanonColorSpaces.py
@@ -1,6 +1,10 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
+"""
+Implements support for *Canon* colorspaces conversions and transfer functions.
+"""
+
 import array
 
 import aces_ocio.generateLUT as genlut
diff --git a/aces_1.0.0/python/aces_ocio/createREDColorSpaces.py b/aces_1.0.0/python/aces_ocio/createREDColorSpaces.py
index 74d375f..f714e45 100644
--- a/aces_1.0.0/python/aces_ocio/createREDColorSpaces.py
+++ b/aces_1.0.0/python/aces_ocio/createREDColorSpaces.py
@@ -1,6 +1,10 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
+"""
+Implements support for *RED* colorspaces conversions and transfer functions.
+"""
+
 import array
 
 import aces_ocio.generateLUT as genlut
diff --git a/aces_1.0.0/python/aces_ocio/createSonyColorSpaces.py b/aces_1.0.0/python/aces_ocio/createSonyColorSpaces.py
index a7eaef1..51be98f 100644
--- 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
diff --git a/aces_1.0.0/python/aces_ocio/create_aces_config.py b/aces_1.0.0/python/aces_ocio/create_aces_config.py
index 49943bf..e97d5d7 100755
--- a/aces_1.0.0/python/aces_ocio/create_aces_config.py
+++ b/aces_1.0.0/python/aces_ocio/create_aces_config.py
@@ -2,41 +2,7 @@
 # -*- coding: utf-8 -*-
 
 """
-usage from python:
-
->>> import sys
->>> sys.path.append("/path/to/script")
->>> import create_aces_config as cac
->>> acesReleaseCTLDir = "/path/to/github/checkout/releases/v0.7.1/transforms/ctl"
->>> configDir = "/path/to/config/dir"
->>> cac.createACESConfig(acesReleaseCTLDir, configDir, 1024, 33, True)
-
-usage from command line, from the directory with 'create_aces_config.py':
-
-$ python create_aces_config.py -a "/path/to/github/checkout/releases/v0.7.1/transforms/ctl" -c "/path/to/config/dir" --lutResolution1d 1024 --lutResolution3d 33 --keepTempImages
-
-
-build instructions for osx for needed packages.
-
-#opencolorio
-brew install -vd opencolorio --with-python
-
-#openimageio
-brew tap homebrew/science
-
-# optional installs
-brew install -vd libRaw
-brew install -vd OpenCV
-
-brew install -vd openimageio --with-python
-
-#ctl
-brew install -vd CTL
-
-#opencolorio - again.
-# this time, 'ociolutimage' will build because openimageio is installed
-brew uninstall -vd opencolorio
-brew install -vd opencolorio --with-python
+Defines objects creating the *ACES* configuration.
 """
 
 import math
diff --git a/aces_1.0.0/python/aces_ocio/generateLUT.py b/aces_1.0.0/python/aces_ocio/generateLUT.py
index 8e420aa..df3cbed 100644
--- a/aces_1.0.0/python/aces_ocio/generateLUT.py
+++ b/aces_1.0.0/python/aces_ocio/generateLUT.py
@@ -2,27 +2,8 @@
 # -*- coding: utf-8 -*-
 
 """
-build instructions for osx for needed packages.
-
-#opencolorio
-brew install -vd opencolorio --with-python
-
-#openimageio
-brew tap homebrew/science
-
-# optional installs
-brew install -vd libRaw
-brew install -vd OpenCV
-
-brew install -vd openimageio --with-python
-
-#ctl
-brew install -vd CTL
-
-#opencolorio - again.
-# this time, 'ociolutimage' will build because openimageio is installed
-brew uninstall -vd opencolorio
-brew install -vd opencolorio --with-python
+Defines objects to generate various kind of 1d, 2d and 3d LUTs in various file
+formats.
 """
 
 import array
diff --git a/aces_1.0.0/python/aces_ocio/process.py b/aces_1.0.0/python/aces_ocio/process.py
index 1a3506b..24fb940 100755
--- a/aces_1.0.0/python/aces_ocio/process.py
+++ b/aces_1.0.0/python/aces_ocio/process.py
@@ -2,8 +2,8 @@
 # -*- coding: utf-8 -*-
 
 """
-A process wrapper class that maintains the text output and execution status
-of a process or a list of other process wrappers which carry such data.
+A process wrapper class that maintains the text output and execution status of
+a process or a list of other process wrappers which carry such data.
 """
 
 import os
diff --git a/aces_1.0.0/python/aces_ocio/util.py b/aces_1.0.0/python/aces_ocio/util.py
index f7b2e23..f6dfcca 100644
--- a/aces_1.0.0/python/aces_ocio/util.py
+++ b/aces_1.0.0/python/aces_ocio/util.py
@@ -1,6 +1,10 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
+"""
+Defines various package utilities objects.
+"""
+
 import os
 import re
 
-- 
1.7.10.4