add_column and add_item erroneously(?) require new_fingerprint parameter
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 68/100
Research direction
Start in src/datasets/arrow_dataset.py at the add_column and add_item signatures referenced in the issue, then compare their docstrings with the dataset constructor's optional fingerprint parameter. Confirm the intended public API behavior and update either the signatures or documentation consistently. Done means both methods' behavior and documentation agree, with coverage for the corrected interface.
Written by the indexing model from the issue text.
Description
Describe the bug
Contradicting their documentation (which doesn't mention the parameter at all), both Dataset.add_column and Dataset.add_item require a new_fingerprint string. This parameter is passed directly to the dataset constructor, which has the fingerprint parameter listed as optional; is there any reason it shouldn't be optional in these methods as well?
Steps to reproduce the bug
Reproduction steps:
- Look at the function signature for add_column: https://github.com/huggingface/datasets/blob/17f40a318a1f8c7d33c2a4dd17934f81d14a7f57/src/datasets/arrow_dataset.py#L6078
- Repeat for add_item: https://github.com/huggingface/datasets/blob/17f40a318a1f8c7d33c2a4dd17934f81d14a7f57/src/datasets/arrow_dataset.py#L6336
Expected behavior
add_column and add_item should either set the fingerprint parameter to optional or include it in their docstrings
Environment info
Not environment-dependent
- Dominant language
- Python
- Stars
- 22k
- Forks
- 3.4k
- Avg merge
- 4d 4h
- Merged PRs (30d)
- 15
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from huggingface/datasets
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
huggingface/datasets#8618 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
huggingface/datasets#8617 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
huggingface/datasets#8608 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
huggingface/datasets#8590 · 2 comments ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
huggingface/datasets#8543 · 2 comments ·
All issues in huggingface/datasets
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100