Fix FileSystems documentation #2551
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.
What this fixes:
This PR resolves several issues I discovered in the documentation on the
datasets.filesystemsmodule (this page).What were the issues?
When I originally tried implementing the code examples I faced several bugs attributed to:
S3FileSystemclass name (written asS3Filesystemin one place)S3FileSystemclass constructor (uses parametersessionsinstead ofsessionin some places) (sees3fsfor where this constructor signature is defined)Testing/reviewing notes
Instructions for generating the documentation locally: here.