add docstrings

Author: miklos1

pyop2/host.py

@@ -819,6 +819,21 @@ def generate_code(self):
 def wrapper_snippets(itspace, args,
                      kernel_name=None, wrapper_name=None, user_code=None,
                      iteration_region=ALL, applied_blas=False):
+    """Generates code snippets for the wrapper,
+    ready to be into a template.
+
+    :param itspace: :class:`IterationSpace` object of the :class:`ParLoop`,
+                    This is built from the iteration :class:`Set`.
+    :param args: :class:`Arg`s of the :class:`ParLoop`
+    :param kernel_name: Kernel function name (forwarded)
+    :param user_code: Code to insert into the wrapper (forwarded)
+    :param wrapper_name: Wrapper function name (forwarded)
+    :param iteration_region: Iteration region, this is specified when
+                             creating a :class:`ParLoop`.
+    :param applied_blas: COFFEE sometimes sets this true.
+
+    :return: dict containing the code snippets
+    """
 
     assert kernel_name is not None
     if wrapper_name is None:
@@ -827,9 +842,6 @@ def wrapper_snippets(itspace, args,
         user_code = ""
 
     direct = all(a.map is None for a in args)
-    # args, iteration_region: directly specified
-    # itspace: built from iterset
-    # applied_blas: False, except when COFFEE turns it on
 
     def itspace_loop(i, d):
         return "for (int i_%d=0; i_%d<%d; ++i_%d) {" % (i, i, d, i)

pyop2/sequential.py

@@ -157,6 +157,21 @@ def _compute(self, part, fun, *arglist):
 
 
 def generate_cell_wrapper(itspace, args, forward_args=(), kernel_name=None, wrapper_name=None):
+    """Generates wrapper for a single cell. No iteration loop, but cellwise data is extracted.
+    Cell is expected as an argument to the wrapper. For extruded, the numbering of the cells
+    is columnwise continuous, bottom to top.
+
+    :param itspace: :class:`IterationSpace` object. Can be built from
+                    iteration :class:`Set` using pyop2.base.build_itspace
+    :param args: :class:`Arg`s
+    :param forward_args: To forward unprocessed arguments to the kernel via the wrapper,
+                         give an iterable of strings describing their C types.
+    :param kernel_name: Kernel function name
+    :param wrapper_name: Wrapper function name
+
+    :return: string containing the C code for the single-cell wrapper
+    """
+
     direct = all(a.map is None for a in args)
     snippets = host.wrapper_snippets(itspace, args, kernel_name=kernel_name, wrapper_name=wrapper_name)