Skip to content
Snippets Groups Projects
Commit 4334b05a authored by Isuru Fernando's avatar Isuru Fernando
Browse files

More doc fixes

parent d36fa6ea
No related branches found
No related tags found
No related merge requests found
......@@ -318,4 +318,5 @@ intersphinx_mapping = {
'https://documen.tician.de/pytential/': None,
'https://documen.tician.de/boxtree/': None,
'https://docs.sympy.org/latest/': None,
'https://matplotlib.org/': None,
}
Welcome to sumpy's documentation!
=================================
.. automodule:: sumpy
Example
-------
......
Misc Tools
==========
.. automodule:: sumpy.tools
Installation
============
......
......@@ -81,7 +81,7 @@ class KernelArgument(object):
"""
.. attribute:: loopy_arg
A :class:`loopy.Argument` instance describing the type,
A :class:`loopy.KernelArgument` instance describing the type,
name, and other features of this kernel argument when
passed to a generated piece of code.
"""
......
......@@ -37,9 +37,9 @@ class CalculusPatch(object):
"""Sets up a grid of points on which derivatives can be calculated. Useful
to verify that an evaluated potential actually solves a PDE.
.. attribute: dim
.. attribute:: dim
.. attribute: points
.. attribute:: points
shape: ``(dim, npoints_total)``
......@@ -118,7 +118,7 @@ class CalculusPatch(object):
def basis(self):
"""
:returns: a :class:`list` containing functions that realize
a high-order interpolation basis on the :attr:`points`.
a high-order interpolation basis on the :py:attr:`points`.
"""
from pytools import indices_in_shape
......
......@@ -25,6 +25,15 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
"""
__doc__ = """
Misc tools
==========
.. autoclass:: BlockIndexRanges
.. autoclass:: MatrixBlockIndexRanges
"""
import six
from six.moves import range, zip
from pytools import memoize_method, memoize_in
......@@ -342,6 +351,7 @@ class MatrixBlockIndexRanges(object):
.. automethod:: block_shape
.. automethod:: block_take
.. automethod:: get
.. autoattribute:: linear_row_indices
.. automethod:: take
"""
......@@ -392,8 +402,8 @@ class MatrixBlockIndexRanges(object):
friends.
:return: a copy of `self` in which all data lives on the host, i.e.
all :class:`pyopencl.array.Array` instances are replaces by
:class:`numpy.ndarray` instances.
all :class:`pyopencl.array.Array` instances are replaces by
:class:`numpy.ndarray` instances.
"""
return MatrixBlockIndexRanges(self.cl_context,
row=self.row.get(queue=queue),
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment