Skip to content

Conversation

@jayceslesar
Copy link
Contributor

@jayceslesar jayceslesar commented Aug 3, 2025

Which issue does this PR close?

Closes #6471

Rationale for this change

Adds some documentation on local usage to go over the root concept, as well as show some basic examples of reading and writing.

I think it makes sense to explicitly mark these docs as local usage as I was playing around with S3, and noticed that we do not need to specify a root like we do for local usage, which is why I added the documentation about the root argument/concept. I am happy to write more docs for S3 usage in the future!

I believe these docs can be slightly cleaned up if/when #6479 is implemented as it seems clunky to have to explicitly get the Path object as a string in the example code.

What changes are included in this PR?

Just documentation changes.

Are there any user-facing changes?

No code changes, but documentation is user-facing :)

@dosubot dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. releases-note/docs The PR modifies docs related content or has a title that begins with "docs" labels Aug 3, 2025
Copy link
Member

@erickguan erickguan left a comment

Choose a reason for hiding this comment

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

You wrote a great guide.

I recommend putting this under either Examples or having a new section called "Tutorials".

I know the index page can get some more love but being concise is nice.

Copy link
Member

@erickguan erickguan left a comment

Choose a reason for hiding this comment

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

Great, thanks!

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Oct 16, 2025
@jayceslesar
Copy link
Contributor Author

@erickguan happy to add more detailed examples to that section in the future! (S3, google drive, local ect)

@erickguan
Copy link
Member

Please do! Happy to discuss this with you if you are not sure where to organize the documentation.

@erickguan erickguan merged commit f859ea2 into apache:main Oct 16, 2025
283 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lgtm This PR has been approved by a maintainer releases-note/docs The PR modifies docs related content or has a title that begins with "docs" size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

new feature: Better python docs

2 participants