Merge remote-tracking branch 'dev/NIFTy_5' into docstrings_pa

nifty5/domains/lm_space.py

@@ -32,13 +32,13 @@ class LMSpace(StructuredDomain):
     lmax : int
         The maximum :math:`l` value of any spherical harmonic coefficient
         :math:`a_{lm}` that is represented by this object.
-        Must be :math:`\ge 0`.
+        Must be :math:`\\ge 0`.
 
     mmax : int, optional
         The maximum :math:`m` value of any spherical harmonic coefficient
         :math:`a_{lm}` that is represented by this object.
         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"]

nifty5/linearization.py

@@ -94,7 +94,7 @@ class Linearization(object):
 
     @property
     def want_metric(self):
-        """bool : the value of `want_metric`"""
+        """bool : True iff the metric was requested in the constructor"""
         return self._want_metric
 
     @property

nifty5/operators/endomorphic_operator.py

@@ -23,9 +23,8 @@ from .linear_operator import LinearOperator
 class EndomorphicOperator(LinearOperator):
     """NIFTy class for endomorphic operators.
 
-    The  NIFTy EndomorphicOperator class is a class derived from the
-    LinearOperator. By definition, domain and target are the same in
-    EndomorphicOperator.
+    The  NIFTy EndomorphicOperator describes linear operators with identical
+    domain and target.
     """
 
     @property

nifty5/operators/simple_linear_operators.py

@@ -109,16 +109,17 @@ class FieldAdapter(LinearOperator):
 
 
 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
     ----------
     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`.
 
     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`.
 
     name : string

nifty5/utilities.py

@@ -182,7 +182,7 @@ def NiftyMetaBase():
     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
     :py:class:`collections.Mapping` interface. It can be used as a drop-in