Skip to content
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

Documentation for array #291

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Conversation

JohanMabille
Copy link
Collaborator

No description provided.

docs/source/array.md Outdated Show resolved Hide resolved
docs/source/array.md Outdated Show resolved Hide resolved
### Reading
These methods return pointers to the internal Arrow structures. One must NOT release
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"One must NOT release the returned structures after using them."
You mean the user should not call the release callback ?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, I can make the formulation more precise.

docs/source/array.md Outdated Show resolved Hide resolved
docs/source/array.md Outdated Show resolved Hide resolved
include/sparrow/array_api.hpp Outdated Show resolved Hide resolved
### Reading

These methods return pointers to the internal Arrow structures. One must NOT call the
`release` method od these structures after use. The array will release them upon
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`release` method od these structures after use. The array will release them upon
`release` method on these structures after use. The sparrow array object will release them upon

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants