Commit d58f9a36 authored by Martin Reinecke's avatar Martin Reinecke
Browse files

improve docs

parent 735fc6e8
...@@ -32,13 +32,13 @@ class LMSpace(StructuredDomain): ...@@ -32,13 +32,13 @@ class LMSpace(StructuredDomain):
lmax : int lmax : int
The maximum :math:`l` value of any spherical harmonic coefficient The maximum :math:`l` value of any spherical harmonic coefficient
:math:`a_{lm}` that is represented by this object. :math:`a_{lm}` that is represented by this object.
Must be :math:`\ge 0`. Must be :math:`\\ge 0`.
mmax : int, optional mmax : int, optional
The maximum :math:`m` value of any spherical harmonic coefficient The maximum :math:`m` value of any spherical harmonic coefficient
:math:`a_{lm}` that is represented by this object. :math:`a_{lm}` that is represented by this object.
If not supplied, it is set to `lmax`. If not supplied, it is set to `lmax`.
Must be :math:`\ge 0` and :math:`\le` `lmax`. Must be :math:`\\ge 0` and :math:`\\le` `lmax`.
""" """
_needed_for_hash = ["_lmax", "_mmax"] _needed_for_hash = ["_lmax", "_mmax"]
......
...@@ -95,7 +95,7 @@ class Linearization(object): ...@@ -95,7 +95,7 @@ class Linearization(object):
@property @property
def want_metric(self): def want_metric(self):
"""bool : the value of `want_metric`""" """bool : True iff the metric was requested in the constructor"""
return self._want_metric return self._want_metric
@property @property
......
...@@ -109,16 +109,17 @@ class FieldAdapter(LinearOperator): ...@@ -109,16 +109,17 @@ class FieldAdapter(LinearOperator):
def ducktape(left, right, name): def ducktape(left, right, name):
"""Convenience function for computing an adapter between two operators. """Convenience function creating an operator that converts between a
DomainTuple and a single-entry MultiDomain.
Parameters Parameters
---------- ----------
left : None, Operator, or Domainoid left : None, Operator, or Domainoid
Something describing the input domain of the left operator. Something describing the new operator's target domain.
If `left` is an `Operator`, its domain is used as `left`. If `left` is an `Operator`, its domain is used as `left`.
right : None, Operator, or Domainoid right : None, Operator, or Domainoid
Something describing the target domain of the right operator. Something describing the new operator's input domain.
If `right` is an `Operator`, its target is used as `right`. If `right` is an `Operator`, its target is used as `right`.
name : string name : string
......
...@@ -182,7 +182,7 @@ def NiftyMetaBase(): ...@@ -182,7 +182,7 @@ def NiftyMetaBase():
return with_metaclass(NiftyMeta, type('NewBase', (object,), {})) return with_metaclass(NiftyMeta, type('NewBase', (object,), {}))
class frozendict(collections.Mapping): class frozendict(collections.abc.Mapping):
""" """
An immutable wrapper around dictionaries that implements the complete An immutable wrapper around dictionaries that implements the complete
:py:class:`collections.Mapping` interface. It can be used as a drop-in :py:class:`collections.Mapping` interface. It can be used as a drop-in
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment