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

Fix filesystem docstring #4283

Merged

Conversation

stevhliu
Copy link
Member

@stevhliu stevhliu commented May 4, 2022

This PR untangles the S3FileSystem docstring so the parameters are properly displayed.

@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented May 4, 2022

The documentation is not available anymore as the PR was closed or merged.

@stevhliu stevhliu requested a review from lhoestq May 4, 2022 21:28
Copy link
Member

@albertvillanova albertvillanova left a comment

Choose a reason for hiding this comment

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

Thank you.

Just small typos/nits below: feel free to ignore any of them if you think it is not pertinent.

On the other hand, the CI is not passing because re is imported but no longer used. You should remove the line:

import re

and the blank line below it.

src/datasets/filesystems/s3filesystem.py Outdated Show resolved Hide resolved
src/datasets/filesystems/s3filesystem.py Outdated Show resolved Hide resolved
src/datasets/filesystems/s3filesystem.py Outdated Show resolved Hide resolved
src/datasets/filesystems/s3filesystem.py Outdated Show resolved Hide resolved
src/datasets/filesystems/s3filesystem.py Outdated Show resolved Hide resolved
src/datasets/filesystems/s3filesystem.py Outdated Show resolved Hide resolved
src/datasets/filesystems/s3filesystem.py Outdated Show resolved Hide resolved
src/datasets/filesystems/s3filesystem.py Outdated Show resolved Hide resolved
src/datasets/filesystems/s3filesystem.py Outdated Show resolved Hide resolved
src/datasets/filesystems/s3filesystem.py Outdated Show resolved Hide resolved
Copy link
Member

@albertvillanova albertvillanova left a comment

Choose a reason for hiding this comment

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

Thanks.

@albertvillanova albertvillanova merged commit 97721d1 into huggingface:master May 6, 2022
@stevhliu stevhliu deleted the fix-filesystem-docstring branch May 6, 2022 16:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants