Commit c98f82cb authored by Philipp Arras's avatar Philipp Arras
Browse files

Typo in docs

parent f296d547
Pipeline #102354 passed with stages
in 12 minutes and 14 seconds
...@@ -592,11 +592,11 @@ def calculate_position(operator, output): ...@@ -592,11 +592,11 @@ def calculate_position(operator, output):
def is_operator(obj): def is_operator(obj):
"""Checks if object is operator-like. """Check if object is operator-like.
Note Note
---- ----
A simple `isinstance(obj, ift.Operator)` does give the expected A simple `isinstance(obj, ift.Operator)` does not give the expected
result because, e.g., :class:`~nifty7.field.Field` inherits from result because, e.g., :class:`~nifty7.field.Field` inherits from
:class:`~nifty7.operators.operator.Operator`. :class:`~nifty7.operators.operator.Operator`.
""" """
...@@ -604,19 +604,20 @@ def is_operator(obj): ...@@ -604,19 +604,20 @@ def is_operator(obj):
def is_linearization(obj): def is_linearization(obj):
"""Checks if object is linearization-like.""" """Check if object is linearization-like."""
return isinstance(obj, Operator) and obj.jac is not None return isinstance(obj, Operator) and obj.jac is not None
def is_fieldlike(obj): def is_fieldlike(obj):
"""Checks if object is field-like. """Check if object is field-like.
Note Note
---- ----
A simple `isinstance(obj, ift.Field)` does give the expected A simple `isinstance(obj, ift.Field)` does not give the expected
result because users might have implemented another class which result because users might have implemented another class which
behaves field-like but is not an instance of behaves field-like but is not an instance of
:class:`~nifty7.field.Field`. Also not that instances of :class:`~nifty7.field.Field`. Instances of
:class:`~nifty7.linearization.Linearization` behave field-like. :class:`~nifty7.linearization.Linearization` are considered to be
field-like.
""" """
return isinstance(obj, Operator) and obj.val is not None return isinstance(obj, Operator) and obj.val is not None
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