From 543742a79814d4050db0560176e1c59d18a3562a Mon Sep 17 00:00:00 2001 From: Jim Turner Date: Wed, 17 Feb 2021 00:27:34 -0500 Subject: [PATCH] Clarify docs of .slice_collapse() --- src/impl_methods.rs | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/impl_methods.rs b/src/impl_methods.rs index afd915786..d039d68a6 100644 --- a/src/impl_methods.rs +++ b/src/impl_methods.rs @@ -450,6 +450,14 @@ where /// Slice the array in place without changing the number of dimensions. /// + /// In particular, if an axis is sliced with an index, the axis is + /// collapsed, as in [`.collapse_axis()`], rather than removed, as in + /// [`.slice_move()`] or [`.index_axis_move()`]. + /// + /// [`.collapse_axis()`]: #method.collapse_axis + /// [`.slice_move()`]: #method.slice_move + /// [`.index_axis_move()`]: #method.index_axis_move + /// /// See [*Slicing*](#slicing) for full documentation. /// See also [`s!`], [`SliceArg`], and [`SliceInfo`](crate::SliceInfo). ///