Updating changes to reflect new documentation

Author: pavanky

__af_version__.py

@@ -9,6 +9,6 @@
 # http://arrayfire.com/licenses/BSD-3-Clause
 ########################################################
 
-version = "3.3"
-release = "20160624"
+version = "3.4"
+release = "20160925"
 full_version = version + "." + release

arrayfire/array.py

@@ -305,6 +305,7 @@ class Array(BaseArray):
                - 'L' for unsigned 64 bit integer
                - 'F' for 32 bit complex number
                - 'D' for 64 bit complex number
+
            - if arrayfire.Dtype, must be one of the following:
                - Dtype.f32 for float
                - Dtype.f64 for double
@@ -318,6 +319,7 @@ class Array(BaseArray):
                - Dtype.u64 for unsigned 64 bit integer
                - Dtype.c32 for 32 bit complex number
                - Dtype.c64 for 64 bit complex number
+
             - if None, Dtype.f32 is assumed
 
     Attributes

arrayfire/lapack.py

@@ -142,6 +142,7 @@ def cholesky(A, is_upper=True):
     (R,info): tuple of af.Array, int.
            - R - triangular matrix.
            - info - 0 if decomposition sucessful.
+
     Note
     ----
 

arrayfire/random.py

@@ -186,7 +186,7 @@ def get_seed():
     Get the seed for the random number generator.
 
     Returns
-    ----------
+    -------
     seed: int.
           Seed for the random number generator
     """
@@ -221,7 +221,7 @@ def get_default_random_engine():
     Get the default random engine
 
     Returns
-    ------
+    -------
 
     The default random engine used by randu and randn
     """

arrayfire/sparse.py

@@ -115,7 +115,7 @@ def create_sparse_from_dense(dense, storage = STORAGE.CSR):
     safe_call(backend.get().af_create_sparse_array_from_dense(c_pointer(out.arr), dense.arr, storage.value))
     return out
 
-def create_sparse_to_dense(sparse):
+def convert_sparse_to_dense(sparse):
     """
     Create a dense matrix from a sparse matrix.
 
@@ -256,7 +256,7 @@ def sparse_get_storage(sparse):
     safe_call(backend.get().af_sparse_get_storage(c_pointer(storage), sparse.arr))
     return __to_sparse_enum[storage.value]
 
-def sparse_convert_to(sparse, storage):
+def convert_sparse(sparse, storage):
     """
     Convert sparse matrix from one format to another.
 

docs/arrayfire.random.rst

@@ -0,0 +1,7 @@
+arrayfire.random module
+=========================
+
+.. automodule:: arrayfire.random
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/arrayfire.rst

@@ -6,7 +6,7 @@ Introduction
 
 .. automodule:: arrayfire
 
-       Submodules
+Submodules
 ----------
 
 .. autosummary::
@@ -27,6 +27,8 @@ Introduction
    arrayfire.lapack
    arrayfire.library
    arrayfire.opencl
+   arrayfire.random
+   arrayfire.sparse
    arrayfire.signal
    arrayfire.statistics
    arrayfire.timer

docs/arrayfire.sparse.rst

@@ -0,0 +1,7 @@
+arrayfire.sparse module
+=========================
+
+.. automodule:: arrayfire.sparse
+    :members:
+    :undoc-members:
+    :show-inheritance: