Skip to content

Improve documentation of slicing methods. #989

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cassiersg wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improve documentation of slicing methods. #989

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Improve documentation of slicing methods.
  • Loading branch information
@cassiersg
cassiersg committed Apr 28, 2021
commit 1aae5a8ea2e406f3368a5181338d31c0c0cf278b
9 changes: 6 additions & 3 deletions src/impl_methods.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,8 @@ where
/// Return a sliced view of the array.
///
/// See [*Slicing*](#slicing) for full documentation.
/// See also [`s!`], [`SliceArg`], and [`SliceInfo`](crate::SliceInfo).
/// See also [`s!`], [`SliceArg`], [`SliceInfo`](crate::SliceInfo),
/// [`.slice_mut()`]: #method.slice_mut and [`.slice_move()`]: #method.slice_move.
///
/// **Panics** if an index is out of bounds or step size is zero.<br>
/// (**Panics** if `D` is `IxDyn` and `info` does not match the number of array axes.)
Expand All @@ -350,7 +351,8 @@ where
/// Return a sliced read-write view of the array.
///
/// See [*Slicing*](#slicing) for full documentation.
/// See also [`s!`], [`SliceArg`], and [`SliceInfo`](crate::SliceInfo).
/// See also [`s!`], [`SliceArg`], [`SliceInfo`](crate::SliceInfo),
/// [`.slice()`]: #method.slice and [`.slice_move()`]: #method.slice_move.
///
/// **Panics** if an index is out of bounds or step size is zero.<br>
/// (**Panics** if `D` is `IxDyn` and `info` does not match the number of array axes.)
Expand Down Expand Up @@ -396,7 +398,8 @@ where
/// Slice the array, possibly changing the number of dimensions.
///
/// See [*Slicing*](#slicing) for full documentation.
/// See also [`s!`], [`SliceArg`], and [`SliceInfo`](crate::SliceInfo).
/// See also [`s!`], [`SliceArg`], [`SliceInfo`](crate::SliceInfo),
/// [`.slice()`]: #method.slice and [`.slice_mut()`]: #method.slice_mut.
///
/// **Panics** if an index is out of bounds or step size is zero.<br>
/// (**Panics** if `D` is `IxDyn` and `info` does not match the number of array axes.)
Expand Down