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

Document more HfFilesyStem Methods #2380

Merged

Conversation

lappemic
Copy link
Contributor

@lappemic lappemic commented Jul 8, 2024

Automate and expand HfFileSystem documentation

  • Generates comprehensive docs for all HfFileSystem methods
  • Fetches fsspec docs and adds HuggingFace-specific notes
  • Updates main docs [[autodoc]] to use all for full method listing

Closes #2100

Cc @severo

@severo severo requested a review from Wauplin July 8, 2024 08:54
@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

Copy link
Contributor

@Wauplin Wauplin 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 the PR @lappemic! That's already much much better even if the formatting is not perfect :) See it here: https://moon-ci-docs.huggingface.co/docs/huggingface_hub/pr_2380/en/package_reference/hf_file_system#huggingface_hub.HfFileSystem.

@Wauplin Wauplin merged commit 33b02b5 into huggingface:main Jul 9, 2024
11 of 14 checks passed
@lappemic
Copy link
Contributor Author

lappemic commented Jul 9, 2024

Thanks for the reformatting! Did not realize this when i was looking at it locally!

@lappemic lappemic deleted the 2100-document-more-hffilesystem-methods branch July 9, 2024 07:28
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.

Document more methods of HfFileSystem
3 participants