-
-
Notifications
You must be signed in to change notification settings - Fork 10.8k
DOC: Created fundamentals doc for explanations in ufunc
reference doc
#19516
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi Mukulika! I like the organization and new examples, thanks for that!
I left a couple of comments about formatting (mostly links). I think I understand your goal with reorganizing the order of the sections but can you explain?
Finally, I haven't checked all the details to see if any of that text is outdated, but I'm trusting it's not. If it is maybe it can be updated in a follow-up.
Co-authored-by: Melissa Weber Mendonça <melissawm@gmail.com>
Thanks for helping me with the links @melissawm! As for the broadcasting section- I was wondering if we could remove most of it from here since the information already exists in the Broadcasting doc. We could add a line about
The flow I thought about-
|
Yes about broadcasting - I'd keep the first part:
but maybe link to the main broadcasting doc for the rest (making sure no information is lost in the process) As for the organization that makes total sense, thanks! |
I moved the Broadcastable arrays section to the Broadcasting doc. The "rules" that were written in that section are already explained in the doc so I decided to remove them. Also, let me know if this branch needs a rebase because I had to merge my broadcasting branch into this one and it adds an extra merge commit 🙂 |
You probably do need a rebase - but otherwise this looks good! Thanks for the great work here, @Mukulikaa ! I'll approve but wait for @rossbar to take a look :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very nice work @Mukulikaa ! This is a big re-organization and you've done a nice job of moving & consolidating the relevant info on ufuncs and broadcasting without (AFAICT) losing anything - no small feat!
The page on ufuncs in the reference guide now reads much more like reference material, and the material that was in the theory.broadcasting
doc is now much more discoverable. Thanks!
Closes #16924
Changes:
ufuncs.rst
to a new doc in the Fundamentals section namedbasics.ufunc.rst
.Universal functions (ufunc) basics
but other suggestions are welcome.ufuncs.py
innumpy/doc
has a few examples in it but apart from that the explanations are more or else the same. I thought we could incorporate some examples into the newbasics.ufunc.rst
doc and remove theufuncs.py
file.Let me know what y'all think!
cc: @melissawm @rossbar 🙂