-
-
Notifications
You must be signed in to change notification settings - Fork 288
[DOC] Add usage examples to dataset deletion functions - #1707
[DOC] Add usage examples to dataset deletion functions #1707mahitab-ayman wants to merge 2 commits into
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Adds/updates NumPy-style docstring usage examples in openml.datasets functions to improve discoverability of common dataset API calls.
Changes:
- Added
Examplessections to several dataset-related docstrings (list_qualities,list_datasets,get_datasets,_topic_delete_dataset,delete_dataset). - Minor docstring text improvement for
list_qualities("uploaded to OpenML"). - Fixed indentation of the
delete_datasetreturn statement (whitespace-only change).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Copilot
AI
Mar 9, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In get_datasets the docstring section header is misindented: Examples is currently aligned under the Returns item (extra leading spaces) while the underline -------- is at the normal indentation. This breaks NumPy/numpydoc formatting and can render incorrectly in generated docs. Align Examples with other section headers (same indentation as Returns) and add the usual blank line separation.
Copilot
AI
Mar 9, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The _topic_delete_dataset docstring example uses openml.datasets.functions._topic_delete_dataset(...) after only import openml. openml.datasets does not expose a functions attribute via its __init__.py, so this example will raise AttributeError unless the submodule is explicitly imported. Adjust the example to import the function/submodule explicitly or show an access path that works from import openml alone.
Copilot
AI
Mar 9, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are two blank lines between the last example statement and the closing triple-quote, which is inconsistent with the surrounding docstrings and can lead to odd spacing in rendered docs. Remove the extra blank line so the docstring ends right after a single blank line following the examples.
Copilot
AI
Mar 9, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PR description/title say this change adds usage examples to delete_dataset and _topic_delete_dataset, but this diff also adds examples to list_qualities, list_datasets, and get_datasets. Please either update the PR description to match the actual scope, or split the additional doc changes into a separate PR to keep review scope focused.
cd5bdd3 to
8d7305f
Compare
Uh oh!
There was an error while loading. Please reload this page.
Added usage examples to dataset-related functions (list_qualities, list_datasets, get_datasets, _topic_delete_dataset, delete_dataset) and fixed line-length and docstring formatting issues.