Skip to content

Commit 3db4ddb

Browse files
author
Luke Shaw
committed
Improve clarity of coments.
1 parent a6b2458 commit 3db4ddb

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

src/blosc2/lazyexpr.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -278,9 +278,9 @@ def compute(self, item: slice | list[slice] | None = None, **kwargs: Any) -> blo
278278
Parameters
279279
----------
280280
item: slice, list of slices, optional
281-
If not None, only the chunks that intersect with the slices
282-
in item will be evaluated. If provided, items of the operands to be used in computation.
283-
Important to note that item is used to slice the operands PRIOR to computation.
281+
If provided, item is used to slice the operands *prior* to computation; not to retrieve specified slices of
282+
the evaluated result. This difference between slicing operands and slicing the final expression
283+
is important when reductions or a where clause are used in the expression.
284284
285285
kwargs: Any, optional
286286
Keyword arguments that are supported by the :func:`empty` constructor.
@@ -329,9 +329,9 @@ def __getitem__(self, item: int | slice | Sequence[slice]) -> blosc2.NDArray:
329329
Parameters
330330
----------
331331
item: int, slice or sequence of slices
332-
If provided, items of the operands to be used in computation.
333-
Important to note that item is used to slice the operands PRIOR to computation, not to retrieve specified
334-
slices of the evaluated result.
332+
If provided, item is used to slice the operands *prior* to computation; not to retrieve specified slices of
333+
the evaluated result. This difference between slicing operands and slicing the final expression
334+
is important when reductions or a where clause are used in the expression.
335335
336336
Returns
337337
-------

0 commit comments

Comments
 (0)