Skip to content

Correct three parameter docstrings that disagree with the signatures - #1792

Open
VenishPaneliya wants to merge 1 commit into
openml:mainfrom
VenishPaneliya:fix-stale-parameter-docs
Open

VenishPaneliya wants to merge 1 commit into
openml:mainfrom
VenishPaneliya:fix-stale-parameter-docs

Conversation

@VenishPaneliya

Copy link
Copy Markdown

Metadata

  • Reference Issue: NA
  • New Tests Added: No
  • Documentation Updated: Yes
  • Change Log Entry: Fixes three parameter docstrings in openml.datasets and openml.runs that disagreed with their signatures

Details

Three numpydoc entries describe something the code does not do. All three render through mkdocstrings.

Where Says Code
datasets.functions.get_datasets download_qualities ... (default=True) download_qualities: bool = False
datasets.functions._name_to_id has a download_qualities entry takes no such argument
runs.functions.list_runs display_errors ... (default=None) display_errors: bool = False

The first two look like one leftover: get_dataset's own docstring already says (default=False), so the text was copied before the default flipped, and _name_to_id kept the entry after losing the argument.

Docstrings only, no behaviour change. ruff and ruff-format are clean on both files.

I left list_evaluations's size : int, default 10000 alone — #1724 is already updating that line, and there the documented value describes the batch limit rather than the signature default.

- get_datasets documents download_qualities as (default=True); the
  argument defaults to False, as get_dataset's docstring already says.
- _name_to_id carries a download_qualities entry for an argument it
  does not take; the same stale text as above.
- list_runs documents display_errors as (default=None) for a bool that
  defaults to False.

This branch has not been deployed

No deployments
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.

1 participant