From 0063d93268c65d371cfa4affb5090073c16fffc2 Mon Sep 17 00:00:00 2001 From: Alex Fikl Date: Wed, 27 Jun 2018 16:09:58 -0500 Subject: [PATCH] slightly improve docs --- sumpy/tools.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/sumpy/tools.py b/sumpy/tools.py index 5b4c8c87..ee34abf2 100644 --- a/sumpy/tools.py +++ b/sumpy/tools.py @@ -312,18 +312,18 @@ def _to_host(x, queue=None): class BlockIndexRanges(object): - """Convenience class for working with block indices. + """Convenience class for working with blocks of a global array. .. attribute:: indices - A list of not necessarily continuous integers representing all the - indices making up a block (or range) of a global array. The individual - blocks are delimited using :attr:`ranges`. + A list of not necessarily continuous or increasing integers + representing the indices of a global array. The individual blocks are + delimited using :attr:`ranges`. .. attribute:: ranges A list of nondecreasing integers used to index into :attr:`indices`. - A block (or range) :math:`i` can be retrieved using + A block :math:`i` can be retrieved using `indices[ranges[i]:ranges[i + 1]]`. .. automethod:: block_shape -- GitLab