docs: fixed minor docs errors

#246

docs/downloads.rst

@@ -12,7 +12,7 @@ Per-version updates: :ref:`changelog-main`.
 
 Build instructions: :ref:`building-from-source`.
 
-.. _download-color-configurations:
+.. _contributor-license-agreements:
 
 Contributor License Agreements
 ******************************

docs/installation.rst

@@ -142,7 +142,7 @@ For a simple single-user setup, add the following to ``~/.bashrc``
 The only environment variable you must configure manually is
 :envvar:`OCIO`, which points to the configuration file you wish to
 use. For prebuilt config files, see the
-:ref:`download-color-configurations` download section
+:ref:`downloads` section
 
 To do this, you would add a line to ``~/.bashrc`` (or a per-project
 configuration script etc), for example::

src/pyglue/DocStrings/AllocationTransform.py

@@ -20,7 +20,7 @@ def getAllocation(self):
         """
         pass
 
-    def setAllocation(self):
+    def setAllocation(self, hwalloc):
         """
         setAllocation(hwalloc)
         
@@ -42,7 +42,7 @@ def getVars(self):
         """
         pass
 
-    def setVars(self):
+    def setVars(self, vars):
         """
         setVars(pyvars)
         

src/pyglue/DocStrings/CDLTransform.py

@@ -12,7 +12,7 @@ def equals(self):
     def getXML(self):
         pass
 
-    def setXML(self):
+    def setXML(self, xmltext):
         pass
 
     def getSlope(self):
@@ -30,7 +30,7 @@ def getSOP(self):
     def getSat(self):
         pass
 
-    def setSlope(self):
+    def setSlope(self, slope):
         """
         setSlope(pyData)
         
@@ -41,7 +41,7 @@ def setSlope(self):
         """
         pass
 
-    def setOffset(self):
+    def setOffset(self, offset):
         """
         setOffset(pyData)
         
@@ -52,7 +52,7 @@ def setOffset(self):
         """
         pass
 
-    def setPower(self):
+    def setPower(self, power):
         """
         setPower(pyData)
         
@@ -63,7 +63,7 @@ def setPower(self):
         """
         pass
 
-    def setSOP(self):
+    def setSOP(self, sop):
         """
         setSOP(pyData)
         
@@ -74,7 +74,7 @@ def setSOP(self):
         """
         pass
 
-    def setSat(self):
+    def setSat(self, sat):
         """
         setSAT(pyData)
         
@@ -107,7 +107,7 @@ def getID(self):
         """
         pass
 
-    def setID(self):
+    def setID(self, id):
         """
         setID(str)
         
@@ -129,7 +129,7 @@ def getDescription(self):
         """
         pass
 
-    def setDescription(self):
+    def setDescription(self, desc):
         """
         setDescription(str)
         

src/pyglue/DocStrings/ColorSpace.py

@@ -35,31 +35,31 @@ def createEditableCopy(self):
     def getName(self):
         pass
 
-    def setName(self):
+    def setName(self, name):
         pass
 
     def getFamily(self):
         pass
 
-    def setFamily(self):
+    def setFamily(self, family):
         pass
 
     def getEqualityGroup(self):
         pass
 
-    def setEqualityGroup(self):
+    def setEqualityGroup(self, equalityGroup):
         pass
 
     def getDescription(self):
         pass
 
-    def setDescription(self):
+    def setDescription(self, desc):
         pass
 
     def getBitDepth(self):
         pass
 
-    def setBitDepth(self):
+    def setBitDepth(self, bitDepth):
         pass
 
     def isData(self):
@@ -75,7 +75,7 @@ def isData(self):
         """
         pass
 
-    def setIsData(self):
+    def setIsData(self, isData):
         pass
 
     def getAllocation(self):
@@ -86,18 +86,18 @@ def getAllocation(self):
         """
         pass
 
-    def setAllocation(self):
+    def setAllocation(self, allocation):
         pass
 
     def getAllocationVars(self):
         pass
 
-    def setAllocationVars(self):
+    def setAllocationVars(self, vars):
         pass
 
     def getTransform(self):
         pass
 
-    def setTransform(self):
+    def setTransform(self, transform, direction):
         pass
-
+

src/pyglue/DocStrings/ColorSpaceTransform.py

@@ -17,9 +17,9 @@ def getSrc(self):
         """
         pass
 
-    def setSrc(self):
+    def setSrc(self, srcname):
         """
-        setSrc()
+        setSrc(srcname)
         
         Sets the source ColorSpace in this transform.
         
@@ -39,9 +39,9 @@ def getDst(self):
         """
         pass
 
-    def setDst(self):
+    def setDst(self, dstname):
         """
-        setDst()
+        setDst(dstname)
         
         Sets the destination ColorSpace in this transform.
         

src/pyglue/DocStrings/Config.py

@@ -80,7 +80,7 @@ def getDescription(self):
         """
         pass
 
-    def setDescription(self):
+    def setDescription(self, desc):
         """
         setDescription(desc)
         
@@ -104,7 +104,7 @@ def serialize(self):
         """
         pass
 
-    def getCacheID(self):
+    def getCacheID(self, pycontext=None):
         """
         getCacheID([, pycontext])
         
@@ -138,7 +138,7 @@ def getSearchPath(self):
         """
         pass
 
-    def setSearchPath(self):
+    def setSearchPath(self, searchpath):
         """
         setSearchPath(path)
         
@@ -160,7 +160,7 @@ def getWorkingDir(self):
         """
         pass
 
-    def setWorkingDir(self):
+    def setWorkingDir(self, dirname):
         """
         setWorkingDir(path)
         
@@ -182,7 +182,7 @@ def getColorSpaces(self):
         """
         pass
 
-    def getColorSpace(self):
+    def getColorSpace(self, name):
         """
         getColorSpace(name)
         
@@ -197,7 +197,7 @@ def getColorSpace(self):
         """
         pass
 
-    def addColorSpace(self):
+    def addColorSpace(self, colorSpace):
         """
         addColorSpace(pyColorSpace)
         
@@ -220,7 +220,7 @@ def clearColorSpaces(self):
         """
         pass
 
-    def parseColorSpaceFromString(self):
+    def parseColorSpaceFromString(self, str):
         """
         parseColorSpaceFromString(str)
         
@@ -238,7 +238,7 @@ def parseColorSpaceFromString(self):
         """
         pass
 
-    def setRole(self):
+    def setRole(self, role, csname):
         """
         setRole(role, csname)
         
@@ -275,7 +275,7 @@ def getDisplays(self):
         """
         pass
 
-    def getDefaultView(self):
+    def getDefaultView(self, display):
         """
         getDefaultView(display)
         
@@ -288,7 +288,7 @@ def getDefaultView(self):
         """
         pass
 
-    def getViews(self):
+    def getViews(self, display):
         """
         getViews(display)
         
@@ -301,7 +301,7 @@ def getViews(self):
         """
         pass
 
-    def getDisplayColorSpaceName(self):
+    def getDisplayColorSpaceName(self, display, view):
         """
         getDisplayColorSpaceName(display, view)
         
@@ -316,7 +316,8 @@ def getDisplayColorSpaceName(self):
         :rtype: string
         """
         pass
-    def getDisplayLooks(self):
+
+    def getDisplayLooks(self, display, view):
         """
         getDisplayLooks(display, view)
         
@@ -331,7 +332,8 @@ def getDisplayLooks(self):
         :rtype: string
         """
         pass
-    def addDisplay(self):
+
+    def addDisplay(self, display, view, csname, looks=None):
         """
         addDisplay(display, view, colorSpaceName[, looks])
         
@@ -354,7 +356,7 @@ def clearDisplays(self):
         """
         pass
 
-    def setActiveDisplays(self):
+    def setActiveDisplays(self, dislpays):
         """
         setActiveDisplays(displays)
         
@@ -376,7 +378,7 @@ def getActiveDisplays(self):
         """
         pass
 
-    def setActiveViews(self):
+    def setActiveViews(self, views):
         """
         setActiveViews(views)
         
@@ -409,7 +411,7 @@ def getDefaultLumaCoefs(self):
         """
         pass
 
-    def setDefaultLumaCoefs(self):
+    def setDefaultLumaCoefs(self, coefficients):
         """
         setDefaultLumaCoefs(pyCoef)
         
@@ -420,7 +422,7 @@ def setDefaultLumaCoefs(self):
         """
         pass
 
-    def getLook(self):
+    def getLook(self, lookname):
         """
         getLook(str)
         
@@ -446,7 +448,7 @@ def getLooks(self):
         """
         pass
 
-    def addLook(self):
+    def addLook(self, look):
         """
         addLook(pylook)
         
@@ -461,11 +463,11 @@ def clearLook(self):
         """
         clearLook()
         
-        Clear look in :py:class:`PyOpenColorIO.Config`.
+        Clear looks in :py:class:`PyOpenColorIO.Config`.
         """
         pass
 
-    def getProcessor(self):
+    def getProcessor(self, arg1, arg2=None, direction=None, context=None):
         """
         getProcessor(arg1[, arg2[, direction[, context]])
         
@@ -509,4 +511,4 @@ def getProcessor(self):
         :param context: optional
         :type context: object
         """
-        pass
+        pass