From 58519430f88ad7f6ca17a76b70f81c4a6a7db81d Mon Sep 17 00:00:00 2001
From: Lukas Platz <lukas@lplatz.de>
Date: Thu, 28 Jun 2018 15:29:22 +0200
Subject: [PATCH] added docstring for SelectionOperator
---
nifty5/operators/selection_operator.py | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/nifty5/operators/selection_operator.py b/nifty5/operators/selection_operator.py
index 7f7ecc69a..e2aa8f908 100644
--- a/nifty5/operators/selection_operator.py
+++ b/nifty5/operators/selection_operator.py
@@ -20,6 +20,16 @@ from ..operators import LinearOperator
class SelectionOperator(LinearOperator):
+ """Extracts from a MultiField a copy of the Field
+ living on the subdomain selected by `key`.
+
+ Parameters
+ ----------
+ domain : :class:`MultiDomain`
+ Domain of the MultiFields to be acted on
+ key : :class:`str`
+ String identifier of the wanted subdomain
+ """
def __init__(self, domain, key):
from ..multi import MultiDomain
if not isinstance(domain, MultiDomain):
--
GitLab