Skip to content

Commit ad921de

Browse files
committed
Fix typo in docstring
1 parent 3e757a8 commit ad921de

File tree

2 files changed

+11
-3
lines changed

2 files changed

+11
-3
lines changed

yt/data_objects/selection_objects/data_selection_objects.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -525,7 +525,7 @@ def piter(
525525
indices and the values will be whatever is assigned to the *result*
526526
attribute on the storage during iteration.
527527
barrier : bool
528-
Should a barier be placed at the end of iteration?
528+
Should a barrier be placed at the end of iteration?
529529
dynamic : bool
530530
This governs whether or not dynamic load balancing will be enabled.
531531
This requires one dedicated processor; if this is enabled with a set of

yt/utilities/parallel_tools/parallel_analysis_interface.py

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -506,15 +506,23 @@ def parallel_objects(
506506
indices and the values will be whatever is assigned to the *result*
507507
attribute on the storage during iteration.
508508
barrier : bool
509-
Should a barier be placed at the end of iteration?
509+
Should a barrier be placed at the end of iteration?
510510
dynamic : bool
511511
This governs whether or not dynamic load balancing will be enabled.
512512
This requires one dedicated processor; if this is enabled with a set of
513513
128 processors available, only 127 will be available to iterate over
514514
objects as one will be load balancing the rest.
515515
reduction : Literal[None, "sum", "max", "min", "cat", "cat_on_root"]
516516
This specifies the reduction operation to be applied to the results
517-
from each processor. The default is None, which doesn't apply any.
517+
from each processor.
518+
- None: no reduction will be applied and the storage object will
519+
contain one result per chunk in the container.
520+
- concat: the storage object will contain a flattened list of
521+
each results.
522+
- cat_on_root: same as concat, but only the root processor will
523+
contain anything.
524+
- sum, min, max: the storage object will contain the result
525+
of applying the operation until getting a single value.
518526
519527
Examples
520528
--------

0 commit comments

Comments
 (0)