docs(python): add documentation for local usage #6480
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
Closes #6471
Rationale for this change
Adds some documentation on local usage to go over the
rootconcept, 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
rootlike we do for local usage, which is why I added the documentation about therootargument/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
Pathobject 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
:)