Skip to content

Commit 252c276

Browse files
committed
Fix docs for slice;step case in s![]
Before, the docs were misleading about the calculation of the final step size.
1 parent 24aebf0 commit 252c276

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

src/slice.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -690,8 +690,8 @@ impl_slicenextdim!((), NewAxis, Ix0, Ix1);
690690
/// * *range*: a range with step size 1 to use for slicing that axis.
691691
/// * *range* `;` *step*: a range with step size *step* to use for slicing that axis.
692692
/// * *slice*: a [`Slice`] instance to use for slicing that axis.
693-
/// * *slice* `;` *step*: a range constructed from the start and end of a [`Slice`]
694-
/// instance, with new step size *step*, to use for slicing that axis.
693+
/// * *slice* `;` *step*: a range constructed from a [`Slice`] instance,
694+
/// multiplying the step size by *step*, to use for slicing that axis.
695695
/// * *new-axis*: a [`NewAxis`] instance that represents the creation of a new axis.
696696
/// (Except for [`.slice_collapse()`], which panics on [`NewAxis`] elements.)
697697
///

0 commit comments

Comments
 (0)