Skip to content

docs: add safety warning to Array.from_buffers docstring#49799

Open
avasis-ai wants to merge 1 commit intoapache:mainfrom
avasis-ai:fix-from-buffers-safety-docs
Open

docs: add safety warning to Array.from_buffers docstring#49799
avasis-ai wants to merge 1 commit intoapache:mainfrom
avasis-ai:fix-from-buffers-safety-docs

Conversation

@avasis-ai
Copy link
Copy Markdown

Summary

Adds a .. warning:: directive to the Array.from_buffers docstring to explicitly inform callers that they are responsible for passing valid Arrow data matching the given type, and that passing invalid data may lead to crashes or undefined behavior.

This addresses the concern raised in the issue that users may not be aware of the safety implications of using this low-level API.

Closes #49717

@github-actions
Copy link
Copy Markdown

Thanks for opening a pull request!

If this is not a minor PR. Could you open an issue for this pull request on GitHub? https://github.com/apache/arrow/issues/new/choose

Opening GitHub issues ahead of time contributes to the Openness of the Apache Arrow project.

Then could you also rename the pull request title in the following format?

GH-${GITHUB_ISSUE_ID}: [${COMPONENT}] ${SUMMARY}

or

MINOR: [${COMPONENT}] ${SUMMARY}

See also:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Python] Array.from_buffers docs should mention safety issues

1 participant