Merge pull request #301 from NNPDF/update-py-docs

Update Python docs

Author: cschwan

pineappl_py/pineappl/__init__.py

@@ -1,2 +1,2 @@
 from .pineappl import version as __version__
-from . import bin, fk_table, grid, import_only_subgrid, lumi, subgrid
+from . import bin, fk_table, grid, import_only_subgrid, channel, subgrid

pineappl_py/pineappl/bin.py

@@ -10,10 +10,10 @@ class BinRemapper(PyWrapper):
 
     Parameters
     ----------
-        normalizations : sequence(float)
-            list with normalizations
-        limits : list(tuple(float,float))
-            all bin limits as a flat list
+    normalizations : sequence(float)
+        list with normalizations
+    limits : list(tuple(float,float))
+        all bin limits as a flat list
     """
 
     def __init__(self, normalizations, limits):

pineappl_py/pineappl/channel.py

@@ -0,0 +1,16 @@
+from .pineappl import PyChannel
+from .utils import PyWrapper
+
+
+class Channel(PyWrapper):
+    """
+    Python wrapper object to :class:`~pineappl.pineappl.PyChannel`.
+
+    Parameters
+    ----------
+    entry : list(tuple(int,int,float))
+        sequence describing a channel combination.
+    """
+
+    def __init__(self, entry):
+        self._raw = PyChannel(entry)

pineappl_py/pineappl/fk_table.py

@@ -3,8 +3,7 @@
 
 
 class FkTable(PyWrapper):
-    """Python wrapper object to interface
-    :class:`~pineappl.pineappl.PyFkTable`.
+    """Python wrapper object to interface :class:`~pineappl.pineappl.PyFkTable`.
 
     Parameters
     ----------
@@ -55,13 +54,12 @@ def optimize(self, assumptions="Nf6Ind"):
 
 
 class FkAssumptions(PyWrapper):
-    """Python wrapper object to interface
-    :class:`~pineappl.pineappl.PyFkAssumptions`.
+    """Python wrapper object to interface :class:`~pineappl.pineappl.PyFkAssumptions`.
 
     Parameters
     ----------
-        assumption : str
-            assumption identifier
+    assumption : str
+        assumption identifier
     """
 
     def __init__(self, assumption):