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

GH-45758 [Python] Add AzureFileSystem documentation #45759

Merged
merged 6 commits into from
Mar 15, 2025
Merged

Conversation

jabbera
Copy link
Contributor

@jabbera jabbera commented Mar 13, 2025

Rationale for this change

Missing documentation on AzureFileSystem

What changes are included in this PR?

Added ArrowFileSystem documentation

Are these changes tested?

Not yet

Are there any user-facing changes?

Documentation

@jabbera
Copy link
Contributor Author

jabbera commented Mar 13, 2025

@github-actions crossbow submit preview-docs

Copy link

⚠️ GitHub issue #45758 has been automatically assigned in GitHub to PR creator.

Copy link

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/13826670914

@jabbera
Copy link
Contributor Author

jabbera commented Mar 13, 2025

@kou, can you poke the bot please to build the sample docs? This is mostly github copilot generated but it's not a bad starting point.

@kou
Copy link
Member

kou commented Mar 13, 2025

@github-actions crossbow submit preview-docs

Copy link

Revision: 4f656a6

Submitted crossbow builds: ursacomputing/crossbow @ actions-6df96eacef

Task Status
preview-docs GitHub Actions

@jabbera
Copy link
Contributor Author

jabbera commented Mar 13, 2025

@kou linting errors are all set, first scan of the doc preview looks good to me.

@jabbera
Copy link
Contributor Author

jabbera commented Mar 13, 2025

Hopefully this bumps the pyarrow results when you google/bing/duckduckgo: azure storage pyarrow. The initial results are incredibly slow from a performance perspective.

@github-actions github-actions bot added awaiting committer review Awaiting committer review and removed awaiting review Awaiting review labels Mar 13, 2025
Copy link
Member

@amoeba amoeba left a comment

Choose a reason for hiding this comment

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

Thanks for this. I made a few small suggestions and noticed one thing I think we should change: In the docs preview, instances of AzureFileSystem aren't automatically links as they should be. I think we need to add AzureFileSystem to the list in https://github.com/apache/arrow/blob/main/docs/source/python/api/filesystems.rst. Can you do that and see if it's fixed?

jabbera and others added 4 commits March 13, 2025 13:52
Co-authored-by: Bryce Mecum <petridish@gmail.com>
Co-authored-by: Bryce Mecum <petridish@gmail.com>
Co-authored-by: Bryce Mecum <petridish@gmail.com>
@jabbera
Copy link
Contributor Author

jabbera commented Mar 13, 2025

@amoeba all set. I did notice SubTreeFileSystem in the new file you linked:

It doesn't seem to exist in the main content file. I left it because it's unrelated to my change, but I'm unsure if it will cause an issue.

@jabbera jabbera requested a review from amoeba March 13, 2025 18:08
@kou
Copy link
Member

kou commented Mar 14, 2025

@github-actions crossbow submit preview-docs

Copy link

Revision: 13eae3e

Submitted crossbow builds: ursacomputing/crossbow @ actions-8735425042

Task Status
preview-docs GitHub Actions

Copy link
Member

@amoeba amoeba left a comment

Choose a reason for hiding this comment

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

This looks good now. +1 @kou do you have any edits?

The issues with the links not showing up right in the CI-built docs is due to the fact we don't enable Azure in that build. I'll file a follow-up PR to fix that.

Thanks for the PR!

Edit: Docs for Azure are already tracked in #41496.

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

@kou kou merged commit 69682cd into apache:main Mar 15, 2025
9 checks passed
@kou kou removed the awaiting committer review Awaiting committer review label Mar 15, 2025
Copy link

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

There were no benchmark performance regressions. 🎉

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

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