Skip to content

Commit

Permalink
Clarify docs of .slice_collapse()
Browse files Browse the repository at this point in the history
  • Loading branch information
jturner314 authored and bluss committed Mar 12, 2021
1 parent c4efbbf commit 7506f90
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions src/impl_methods.rs
Expand Up @@ -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).
///
Expand Down

0 comments on commit 7506f90

Please sign in to comment.