Adds module content listing for parse, utils and write

shidarin · Jun 17, 2014 · 9ed020f · 9ed020f
1 parent 54a3f23
commit 9ed020f
Show file tree

Hide file tree

Showing 3 changed files with 60 additions and 1 deletion.
diff --git a/cdl_convert/parse.py b/cdl_convert/parse.py
@@ -6,6 +6,37 @@
 
 Contains parser functions for converting files to cdl_convert objects.
 
+## Public Functions
+
+    parse_ale()
+        Parses an ALE EDL file into a ColorCollection set to ccc.
+
+    parse_cc()
+        Parses an XML CC file into a ColorCorrection.
+
+    parse_ccc()
+        Parses an XML CCC file into a ColorCollection set to ccc.
+
+    parse_cdl
+        Parses an XML CDL file into a ColorCollection set to cdl.
+
+    parse_file()
+        Determines which parse function to call based on file extension (or
+        provided ext arg) and calls that function. Returns result.
+
+    parse_flex()
+        Parses a FLEx EDL into a ColorCollection set to ccc.
+
+    parse_rnh_cdl
+        Parses a Rhythm & Hues Space Separated cdl file, which is based on a
+        very early ASC CDL spec, into a single ColorCorrection.
+
+## GLOBALS
+
+    INPUT_FORMATS
+        A dictionary whose keys are file extensions and values are the above
+        functions. Used by ``parse_file()`` to determine what parser to call.
+
 ## License
 
 The MIT License (MIT)
@@ -60,6 +91,7 @@
     'parse_cc',
     'parse_ccc',
     'parse_cdl',
+    'parse_file',
     'parse_flex',
     'parse_rnh_cdl'
 ]

diff --git a/cdl_convert/utils.py b/cdl_convert/utils.py
@@ -4,7 +4,16 @@
 CDL Convert Utils
 =================
 
-Contains basic utility functions for cdl_convert
+Contains basic utility functions for cdl_convert.
+
+## Public Functions
+
+    sanity_check()
+        Checks the color values of a given ColorCorrection to see if they fall
+        within 'sane' values.
+
+    to_decimal()
+        Converts floats, ints, and strings to Decimal() in a predictable way.
 
 ## License
 

diff --git a/cdl_convert/write.py b/cdl_convert/write.py
@@ -6,6 +6,24 @@
 
 Functions for writing different types of cdls.
 
+## Public Functions
+
+    write_cc()
+        Writes a given ColorCorrection to disk. ``file_out`` should already be
+        set on the ColorCorrection.
+
+    write_ccc()
+        Writes a given ColorCollection to disk. ``file_out`` should already be
+        set on the ColorCollection.
+
+    write_cdl()
+        Writes a given ColorCollection to disk. ``file_out`` should already be
+        set on the ColorCollection.
+
+    write_rnh_cdl()
+        Writes a given ColorCorrection to disk. ``file_out`` should already be
+        set on the ColorCorrection.
+
 ## License
 
 The MIT License (MIT)