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

Add table of conversions to/from Vecs and slices #527

Merged
merged 1 commit into from Nov 11, 2018

Conversation

jturner314
Copy link
Member

This improves discoverability. See also #524 for motivation.

@@ -851,6 +851,25 @@ pub type Ixs = isize;
/// </tr>
/// </table>
///
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we put a heading here, so that it's possible to find this?

I also want to disclaim the as_slice methods with the information that it is of course a conversion that not every array supports. (Arrays are not necessarily contiguous or in order.) I think that this information needs to be stated again, since it is non-obvious to the users that start out.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added headings, and I've added footnotes for the restrictions on .as_slice*().

@bluss
Copy link
Member

bluss commented Nov 4, 2018

I added comments but it doesn't need to be perfect to be merged, this is docs. Nice to have! 🙂

@jturner314 jturner314 merged commit 336fb1a into rust-ndarray:master Nov 11, 2018
@jturner314 jturner314 deleted the doc-more-conversions branch November 11, 2018 17:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants