Skip to content

high-level documentation for __array_function__ missing #13844

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

Jump to bottom
Closed
2 tasks done
rgommers opened this issue Jun 27, 2019 · 2 comments · Fixed by #13979
Closed
2 tasks done

high-level documentation for __array_function__ missing #13844

rgommers opened this issue Jun 27, 2019 · 2 comments · Fixed by #13979
Labels
04 - Documentation component: __array_function__

Comments

@rgommers
Copy link
Member

rgommers commented Jun 27, 2019 •
edited
Loading

This was noted in the tracking issue (gh-12028) but didn't have its own issue. I wanted to refer to these docs today and found them missing.

Documentation is needed in two places:

A bigger-picture issue is that the subclassing doc nor other docs really discuss the issues with subclassing, and when it would be more appropriate to implement a duck array instead.
@rgommers rgommers mentioned this issue Jun 27, 2019
Closed
33 tasks
@rgommers rgommers added this to the 1.17.0 release milestone Jun 27, 2019
@rgommers
Copy link
Member Author

@danielballan is planning to work on this at the sprint tomorrow (thank you!). If anyone else has updates or relevant docs, please comment in the next 20 hours or so.

Two other write-ups that may be useful:

And also my PyData talk from two months ago where I discussed/demoed __array_function__: https://www.youtube.com/watch?v=HVLPJnvInzM&t=10s

@danielballan
Copy link
Contributor

Thanks for the references, @rgommers.

@danielballan danielballan mentioned this issue Jul 13, 2019
Merged
This was referenced Jul 14, 2019
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
04 - Documentation component: __array_function__
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

DOC: Document array_function at a higher level. danielballan/numpy
2 participants
@rgommers @danielballan