Skip to content

Conversation

@albertvillanova
Copy link
Contributor

@albertvillanova albertvillanova commented Aug 7, 2024

Rationale for this change

The LargeListType is missing in the Data Types docs: https://arrow.apache.org/docs/python/api/datatypes.html#type-classes

What changes are included in this PR?

This PR adds the LargeListType to the Data Types docs.

Are these changes tested?

The change only affects the docs. I have generated the docs locally and they appear as expected. See comment below with screenshot: #43597 (comment)

Are there any user-facing changes?

The change is indeed an update in the docs.

@albertvillanova
Copy link
Contributor Author

@github-actions crossbow submit preview-docs

@github-actions
Copy link

github-actions bot commented Aug 7, 2024

Only contributors can submit requests to this bot. Please ask someone from the community for help with getting the first commit in.
The Archery job run can be found at: https://github.com/apache/arrow/actions/runs/10280151106

@mapleFU
Copy link
Member

mapleFU commented Aug 7, 2024

@github-actions crossbow submit preview-docs

@mapleFU
Copy link
Member

mapleFU commented Aug 7, 2024

I'm not familiar with python, would "ListType, LargeListType, FixedSizeListType, ListViewType, LargeListViewType" all required here?

@github-actions
Copy link

github-actions bot commented Aug 7, 2024

Revision: 499a8a1

Submitted crossbow builds: ursacomputing/crossbow @ actions-a5b1f8dee8

Task Status
preview-docs GitHub Actions

@albertvillanova
Copy link
Contributor Author

Yes, I guess all the rest should also be added.

I first added only one of them to check if the docs link works as expected.

@albertvillanova
Copy link
Contributor Author

albertvillanova commented Aug 7, 2024

I have built the docs locally and they work as expected: arrow/docs/_build/html/python/api/datatypes.html#type-classes
Screenshot from 2024-08-07 12-24-13

@mapleFU
Copy link
Member

mapleFU commented Aug 15, 2024

@jorisvandenbossche @kou Do you think this is ok? I don't know the principle for "type-classes" here

@kou kou changed the title MINOR: [Python] Add LargeListType to Data Types docs MINOR: [Docs][Python] Add LargeListType to Data Types docs Aug 15, 2024
Copy link
Member

@kou kou left a comment

Choose a reason for hiding this comment

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

+1

Could you fill the pull request description template before we merge this?

@github-actions github-actions bot added awaiting merge Awaiting merge and removed awaiting review Awaiting review labels Aug 15, 2024
@kou kou merged commit bee2fc8 into apache:main Aug 16, 2024
@kou kou removed the awaiting merge Awaiting merge label Aug 16, 2024
@kou
Copy link
Member

kou commented Aug 16, 2024

Thanks.
Merged.

@conbench-apache-arrow
Copy link

After merging your PR, Conbench analyzed the 7 benchmarking runs that have been run so far on merge-commit bee2fc8.

There was 1 benchmark result indicating a performance regression:

The full Conbench report has more details. It also includes information about 3 possible false positives for unstable benchmarks that are known to sometimes produce them.

@albertvillanova
Copy link
Contributor Author

albertvillanova commented Aug 18, 2024

@kou, after merging this PR into main branch, the modification does not appear in the dev documentation: https://arrow.apache.org/docs/dev/python/api/datatypes.html#type-classes

Do you know why?

@kou
Copy link
Member

kou commented Aug 19, 2024

We need to fix our nightly documentation build: #43743

QuietCraftsmanship pushed a commit to QuietCraftsmanship/arrow that referenced this pull request Jul 7, 2025
### Rationale for this change

The `LargeListType` is missing in the Data Types docs: https://arrow.apache.org/docs/python/api/datatypes.html#type-classes

### What changes are included in this PR?

This PR adds the `LargeListType` to the Data Types docs.

### Are these changes tested?

The change only affects the docs. I have generated the docs locally and they appear as expected. See comment below with screenshot: apache/arrow#43597 (comment)

### Are there any user-facing changes?

The change is indeed an update in the docs.

Authored-by: Albert Villanova del Moral <[email protected]>
Signed-off-by: Sutou Kouhei <[email protected]>
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.

3 participants