Skip to content

Commit 543742a

Browse files
jturner314bluss
authored andcommitted
Clarify docs of .slice_collapse()
1 parent c6f64b2 commit 543742a

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

src/impl_methods.rs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -450,6 +450,14 @@ where
450450

451451
/// Slice the array in place without changing the number of dimensions.
452452
///
453+
/// In particular, if an axis is sliced with an index, the axis is
454+
/// collapsed, as in [`.collapse_axis()`], rather than removed, as in
455+
/// [`.slice_move()`] or [`.index_axis_move()`].
456+
///
457+
/// [`.collapse_axis()`]: #method.collapse_axis
458+
/// [`.slice_move()`]: #method.slice_move
459+
/// [`.index_axis_move()`]: #method.index_axis_move
460+
///
453461
/// See [*Slicing*](#slicing) for full documentation.
454462
/// See also [`s!`], [`SliceArg`], and [`SliceInfo`](crate::SliceInfo).
455463
///

0 commit comments

Comments
 (0)