Commit 2e145d3e authored by Philipp Arras's avatar Philipp Arras
Browse files

Tweaks in docstring

parent 707ea130
Pipeline #103258 passed with stages
in 15 minutes and 23 seconds
...@@ -215,7 +215,7 @@ class GaussianEntropy(EnergyOperator): ...@@ -215,7 +215,7 @@ class GaussianEntropy(EnergyOperator):
Parameters Parameters
---------- ----------
domain: Domain FIXME domain: Domain, DomainTuple, list of Domain
The domain of the diagonal. The domain of the diagonal.
""" """
...@@ -237,7 +237,7 @@ class LowerTriangularInserter(LinearOperator): ...@@ -237,7 +237,7 @@ class LowerTriangularInserter(LinearOperator):
Parameters Parameters
---------- ----------
target: Domain FIXME target: Domain, DomainTuple, list of Domain
A two-dimensional domain with NxN entries. A two-dimensional domain with NxN entries.
""" """
...@@ -266,7 +266,7 @@ class DiagonalSelector(LinearOperator): ...@@ -266,7 +266,7 @@ class DiagonalSelector(LinearOperator):
Parameters Parameters
---------- ----------
domain: Domain FIXME domain: Domain, DomainTuple, list of Domain
The two-dimensional domain of the input field. Must be of shape NxN. The two-dimensional domain of the input field. Must be of shape NxN.
""" """
......
...@@ -27,7 +27,10 @@ class Multifield2Vector(LinearOperator): ...@@ -27,7 +27,10 @@ class Multifield2Vector(LinearOperator):
"""Flatten a MultiField and return a Field with unstructured domain and the """Flatten a MultiField and return a Field with unstructured domain and the
same number of degrees of freedom. same number of degrees of freedom.
FIXME Parameters
----------
domain: MultiDomain
Domain of the operator
""" """
def __init__(self, domain): def __init__(self, domain):
......
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