From d853886000cb4b3e666ab73c6f1ee6e8409554d9 Mon Sep 17 00:00:00 2001
From: Lukas Platz <lukas@lplatz.de>
Date: Mon, 28 Jan 2019 16:16:17 +0100
Subject: [PATCH] modified domain.local_shape's docstring
It is rendered in the docs before domain.shape and as such hard
to understand, because it explains two concepts (shape, MPI data
splitting) at once.
Therefore I added the hint that it is mainly relevant for MPI
and that the docstring of domain.shape explains the shape concept
in general.
---
nifty5/domains/domain.py | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/nifty5/domains/domain.py b/nifty5/domains/domain.py
index de8808971..c5c332eda 100644
--- a/nifty5/domains/domain.py
+++ b/nifty5/domains/domain.py
@@ -86,7 +86,10 @@ class Domain(metaclass=NiftyMeta):
@property
def local_shape(self):
- """tuple of int: number of pixels along each axis on the local task
+ """tuple of int: number of pixels along each axis on the local task,
+ mainly relevant for MPI.
+
+ See :meth:`.shape()` for general explanation of property.
The shape of the array-like object required to store information
defined on part of the domain which is stored on the local MPI task.
--
GitLab