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.

Sign up for GitHub

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

Jump to bottom

[Python][Docs] Document the PyCapsule protocol in the "extending pyarrow" section of the Python docs #39196

Closed
Tracked by #39195
jorisvandenbossche opened this issue Dec 12, 2023 · 0 comments · Fixed by #39199
Closed
Tracked by #39195

[Python][Docs] Document the PyCapsule protocol in the "extending pyarrow" section of the Python docs #39196

jorisvandenbossche opened this issue Dec 12, 2023 · 0 comments · Fixed by #39199
Assignees
@jorisvandenbossche
Labels
Component: Documentation Component: Python
Milestone
15.0.0

Comments

@jorisvandenbossche
Copy link
Member

jorisvandenbossche commented Dec 12, 2023 •
edited
Loading

While the Arrow PyCapsule protocol itself is defined in the specification part of the docs, we should also mention this in the Python user guide. Currently, the https://arrow.apache.org/docs/dev/python/extending_types.html page already mentions __arrow_array__, but we should also mention the new dunders there.
@jorisvandenbossche jorisvandenbossche mentioned this issue Dec 12, 2023
Open
8 tasks
@jorisvandenbossche jorisvandenbossche changed the title [Python][Docs] Document the protocol in the "extending pyarrow" section of the Python docs (https://arrow.apache.org/docs/dev/python/extending_types.html) [Python][Docs] Document the protocol in the "extending pyarrow" section of the Python docs Dec 12, 2023
@jorisvandenbossche jorisvandenbossche changed the title [Python][Docs] Document the protocol in the "extending pyarrow" section of the Python docs [Python][Docs] Document the PyCapsule protocol in the "extending pyarrow" section of the Python docs Dec 12, 2023
@github-actions github-actions bot mentioned this issue Dec 12, 2023
Merged
jorisvandenbossche added a commit that referenced this issue Dec 21, 2023
@jorisvandenbossche @pitrou
GH-39196: [Python][Docs] Document the Arrow PyCapsule protocol in the…
2f9f892 
… 'extending pyarrow' section of the Python docs (#39199)

### Rationale for this change

While the Arrow PyCapsule protocol itself is defined in the specification part of the docs, this PR adds a section about it in the Python user guide as well (referring to the specification for most details), where users might typically look for Python specific docs.
* Closes: #39196

Lead-authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
Co-authored-by: Antoine Pitrou <pitrou@free.fr>
Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
@jorisvandenbossche jorisvandenbossche added this to the 15.0.0 milestone Dec 21, 2023
clayburn pushed a commit to clayburn/arrow that referenced this issue Jan 23, 2024
@jorisvandenbossche @pitrou @clayburn
apacheGH-39196: [Python][Docs] Document the Arrow PyCapsule protocol …
e797f22 
…in the 'extending pyarrow' section of the Python docs (apache#39199)

### Rationale for this change

While the Arrow PyCapsule protocol itself is defined in the specification part of the docs, this PR adds a section about it in the Python user guide as well (referring to the specification for most details), where users might typically look for Python specific docs.
* Closes: apache#39196

Lead-authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
Co-authored-by: Antoine Pitrou <pitrou@free.fr>
Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
dgreiss pushed a commit to dgreiss/arrow that referenced this issue Feb 19, 2024
@jorisvandenbossche @pitrou @dgreiss
apacheGH-39196: [Python][Docs] Document the Arrow PyCapsule protocol …
92a3a40 
…in the 'extending pyarrow' section of the Python docs (apache#39199)

### Rationale for this change

While the Arrow PyCapsule protocol itself is defined in the specification part of the docs, this PR adds a section about it in the Python user guide as well (referring to the specification for most details), where users might typically look for Python specific docs.
* Closes: apache#39196

Lead-authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
Co-authored-by: Antoine Pitrou <pitrou@free.fr>
Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jorisvandenbossche jorisvandenbossche

Labels
Component: Documentation Component: Python
Projects
None yet
Milestone
15.0.0
1 participant
@jorisvandenbossche