DOC: Added missing C-API functions #19844
Conversation
1. PyArray_CopyObject 2. PyArray_MapIterArray 3. PyArray_MapIterSwapAxes 4. PyArray_MapIterNext 5. PyArray_MapIterArrayCopyIfOverlap
There was a problem hiding this comment.
I can't review the technical details, so I'll leave that for others to look at. The only question I have is if the core/include/numpy/multiarray_api.txt file also needs to be updated to include the "docstring" for PyArray_CopyObject- I'm not sure what is the function of that file.
| @@ -584,25 +584,26 @@ From other objects | |||
| did not have the _ARRAY_ macro namespace in them. That form | |||
| of the constant names is deprecated in 1.7. | |||
|
|
|||
| .. c:macro:: NPY_ARRAY_NOTSWAPPED | |||
| .. c:macro:: NPY_ARRAY_NOTSWAPPED | |||
There was a problem hiding this comment.
These are un-indented on purpose so that the macros can be linked to from elsewhere
|
This seems like a good opportunity to use the new doxygen-breathe infrastructure to pull the comments out of the source files and render them in the rst files |
|
I'd be happy to try it out then! |
I'd suggest merging this once content seems ready, and using Doxygen-Breathe in a follow-up PR to not mix content and tooling changes. |
FWIW the tooling changes have already been merged, so the proposal is to use this as a test-case for the C autodocumentation workflow. @Mukulikaa has expressed interest (or at least willingness) to give this a try and provide feedback on how the process goes. @rgommers brings up a good point though - if you get stuck don't feel the need to keep pushing on the autodocumenting "experiment", that shouldn't be a blocker for the content itself. |
Co-authored-by: Melissa Weber Mendonça <[email protected]>
|
Let's get this in. Thanks @Mukulikaa . |
Added the following functions to NumPy C-API: