DOC: Fix some out-of-data struct in c-api types-and-structures #27582
Conversation
|
Hi, This is my first time submitting a pull request on GitHub, and I apologize for any mistakes made. I added Could someone guide me on how to properly use Thank you for your help! |
|
You need to include |
Sorry! That was me being careless and misunderstanding. I thought this was referring to the |
If you are referring to |
|
I agree. |
|
|
||
| An implementation detail for accessing the :c:data:`PyArrayObject` struct. | ||
| You should use :c:data:`PyArrayObject` to ensure code compatibility and stability. | ||
|
|
There was a problem hiding this comment.
I don't think we should document this internal struct in the documentation of public structures. We hid it on purpose. We could have internal documentation that could document this and other structs.
There was a problem hiding this comment.
Are you referring to PyArrayObject_fields? While it's true that this internal struct is not part of the public API, it can still be accessed via:
#include <numpy/arrayobject.h>
int main() {
PyArrayObject_fields * a;
}
Given that it can be accessed, I believe it might be helpful to at least provide some guidance to users. We could mention its existence with a clear note advising against direct usage, and suggest the appropriate alternatives that should be used instead. This way, users are informed without inadvertently encouraging misuse of internal structures.
|
close/reopen |
github-project-automation
bot
moved this from Awaiting a code review
to Completed
in NumPy first-time contributor PRs
melissawm
moved this from Completed
to Pending authors' response
in NumPy first-time contributor PRs
DOC: Update C-API docs
PyArrayObjecttoPyArrayObject_fields.mem_handlerand_buffer_info.PyArray_Descrmetadata field and addednpy_hash_tdocumentation.PyArray_ArrFuncsandPyUFuncObject.[skip azp] [skip actions] [skip cirrus]