Skip to content
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.

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

Rename AxisSliceInfo to SliceInfoElem #945

Merged
merged 2 commits into from
Mar 17, 2021

Conversation

jturner314
Copy link
Member

@jturner314 jturner314 commented Mar 17, 2021

Closes #944.

I realized that the name AxisSliceInfo isn't a great description for this type because it doesn't correspond to slicing information for a single input axis or a single output axis. This will be especially true if we add another variant for ellipsis-type functionality. The name SliceInfoElem more clearly describes the purpose of this type – to be an element in a list describing the slicing information.

This PR also fixes a small error in the docs for the s![] macro regarding the meaning of the step in slice ; step. (See lines 693–694 of slice.rs.)

The name `AxisSliceInfo` isn't a great description for this type
because it doesn't correspond to slicing information for a single
input axis or a single output axis. This will be especially true if we
add another variant for ellipsis-type functionality. The name
`SliceInfoElem` more clearly describes the purpose of this type – to
be an element in a list describing the slicing information.
Before, the docs were misleading about the calculation of the final
step size.
@jturner314 jturner314 added this to the 0.15.0 milestone Mar 17, 2021
@jturner314 jturner314 merged commit c53d060 into rust-ndarray:master Mar 17, 2021
@jturner314 jturner314 deleted the rename-axissliceinfo branch March 17, 2021 23:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename AxisSliceInfo to SliceInfoElem
2 participants