Add documentation for lena.math.refine_mesh and lena.math.flatten.

docs/source/math.rst

@@ -4,8 +4,10 @@ math package
 
 .. currentmodule:: lena.math.meshes
 .. autosummary::
+    flatten
     mesh
     md_map
+    refine_mesh
 
 **Functions of scalar and multidimensional arguments:**
 
@@ -31,8 +33,10 @@ Functions of multidimensional arguments
 ---------------------------------------
 
 .. module:: lena.math.meshes
+.. autofunction:: flatten
 .. autofunction:: mesh
 .. autofunction:: md_map
+.. autofunction:: refine_mesh
 
 Functions of scalar and multidimensional arguments
 --------------------------------------------------

lena/math/meshes.py

@@ -7,7 +7,7 @@
 def flatten(array):
     """Flatten an *array* of arbitrary dimension.
 
-    Array must be list or a tuple (can be nested).
+    *array* must be list or a tuple (can be nested).
     Depth-first flattening is used.
 
     Return an iterator over the flattened array.
@@ -140,12 +140,15 @@ def mesh_1d(nbins, range_):
 
 
 def refine_mesh(arr, refinement):
-    """Refine (subdivide) a mesh *arr*.
+    """Refine (subdivide) one-dimensional mesh *arr*.
 
-    *refinement* is the number of subdivisions, it must be not less than 1.
+    *refinement* is the number of subdivisions.
+    It must be not less than 1.
 
-    *arr* must be one-dimensional now.
+    Note that to create a new mesh may be faster.
+    Use this function only for convenience.
     """
+    # *arr* must be one-dimensional.
     new_mesh = [arr[0]]
     for low, up in zip(arr, arr[1:]):
         new_mesh.extend(mesh((low, up), refinement)[1:])