docs(py_utils): add missing docstrings to 5 public utility functions#8294
Open
RavSinghChandan wants to merge 1 commit into
Open
docs(py_utils): add missing docstrings to 5 public utility functions#8294RavSinghChandan wants to merge 1 commit into
RavSinghChandan wants to merge 1 commit into
Conversation
Add Args/Returns/Raises/Example docstrings to: - glob_pattern_to_regex - has_sufficient_disk_space - copyfunc - iflatmap_unordered - iter_batched
91bbd5e to
5d3b02f
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 does this PR do?
Adds missing docstrings to five public utility functions in
src/datasets/utils/py_utils.py. Each docstring follows the HuggingFace documentation style withArgs,Returns,Raises, andExamplesections.Functions documented:
glob_pattern_to_regexhas_sufficient_disk_spacecopyfunciflatmap_unorderediter_batchedMotivation
These functions are used throughout the library but lacked any documentation, making it harder for contributors and users to understand their behaviour without reading the implementation.
Tests
No logic changed — documentation only. Existing test suite covers these functions.
ruff checkandruff format --checkboth pass with no errors.