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

Document astype functionality in ndarray #1124

Closed
sgasse opened this issue Nov 28, 2021 · 2 comments
Closed

Document astype functionality in ndarray #1124

sgasse opened this issue Nov 28, 2021 · 2 comments

Comments

@sgasse
Copy link
Contributor

sgasse commented Nov 28, 2021

Hi! I took a stab at Document ndarray's equivalent to NumPy's astype from #597 in this PR:
#1123

Here are a few questions:

  • Which other conversion examples would you like to see?
  • How can I locally build / access the ndarray_for_numpy_users documentation to see how my changes look like? I cannot find the page when running cargo doc --open.
  • Should there be more details on differences in conversion that stem from Rust's type system and are not specific to ndarray? (e.g. np.astype() does not saturate, a.mapv(|x| x as u8 runs a saturated conversion)
@adamreichold
Copy link
Collaborator

How can I locally build / access the ndarray_for_numpy_users documentation to see how my changes look like? I cannot find the page when running cargo doc --open.

I think you just need to enable the docs feature, i.e. run

> cargo doc --features docs --open

@sgasse
Copy link
Contributor Author

sgasse commented Nov 30, 2021

Thank you @adamreichold , that worked 🙏

@sgasse sgasse closed this as completed Jun 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants