Clarify dataset_id docstring in get_dataset (fixes #1066)#1400
Merged
Conversation
PGijsbers
reviewed
May 5, 2025
PGijsbers
approved these changes
May 5, 2025
Collaborator
|
Hey! 👋 thanks for your contribution! Sorry for the slow reply, I was out of office and other core contributors have been busy. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.
This pull request updates the docstring of the get_dataset function in openml/datasets/functions.py to clarify that the dataset_id parameter can be either:
an integer ID (e.g., 61), or
a dataset name as a string (e.g., "iris").
This improves clarity for users reading the documentation and aligns with the function's actual behavior.
Related Issue
Fixes #1066