Repository navigation
Correct three parameter docstrings that disagree with the signatures - #1792
Open
VenishPaneliya wants to merge 1 commit into
Open
VenishPaneliya wants to merge 1 commit into
VenishPaneliya wants to merge 1 commit into
Conversation
- 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
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.
Metadata
openml.datasetsandopenml.runsthat disagreed with their signaturesDetails
Three numpydoc entries describe something the code does not do. All three render through
mkdocstrings.datasets.functions.get_datasetsdownload_qualities ... (default=True)download_qualities: bool = Falsedatasets.functions._name_to_iddownload_qualitiesentryruns.functions.list_runsdisplay_errors ... (default=None)display_errors: bool = FalseThe 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_idkept the entry after losing the argument.Docstrings only, no behaviour change.
ruffandruff-formatare clean on both files.I left
list_evaluations'ssize : int, default 10000alone — #1724 is already updating that line, and there the documented value describes the batch limit rather than the signature default.