Skip to content

[DOC] Fix docstrings and typos in benchmarking module#10501

Merged
fkiraly merged 1 commit into
sktime:mainfrom
NAME-ASHWANIYADAV:doc/fix-benchmarking-docstrings
Jul 10, 2026
Merged

[DOC] Fix docstrings and typos in benchmarking module#10501
fkiraly merged 1 commit into
sktime:mainfrom
NAME-ASHWANIYADAV:doc/fix-benchmarking-docstrings

Conversation

@NAME-ASHWANIYADAV

@NAME-ASHWANIYADAV NAME-ASHWANIYADAV commented Jul 4, 2026

Copy link
Copy Markdown
Contributor

Reference Issues/PRs

Fixes #10500.

What does this implement/fix? Explain your changes.

This PR systematically cleans up docstrings and fixes typos across the sktime/benchmarking module, as described in #10500. Specifically:

  • Fixes typos ("comptaible", "contianing", "receive") in classification.py, forecasting.py, _benchmarking_dataclasses.py, and _utils.py.
  • Corrects parameter mismatches where add_task incorrectly documented data instead of the actual dataset_loader parameter.
  • Updates the outdated docstring for _SktimeRegistry.register in benchmarks.py by removing legacy parameters that no longer exist.
  • Fixes the copy-pasted docstring for _add_estimator in benchmarks.py to accurately state that it accepts a single BaseEstimator.
  • Generalizes the docstring for _coerce_data_for_evaluate in _benchmarking_dataclasses.py to accurately reflect its use across all task types, not just forecasting.

Does your contribution introduce a new dependency? If yes, which one?

No.

What should a reviewer concentrate their feedback on?

A quick sanity check to ensure the updated docstrings accurately reflect the method signatures.

Did you add any tests for the change?

No tests were added as this is strictly a documentation/docstring cleanup. However, all existing benchmarking tests and lint checks pass locally.

Any other comments?

N/A

PR checklist

For all contributions
  • I've added myself to the list of contributors with any new badges I've earned :-)
  • Optionally, for added estimators: I've added myself and possibly to the maintainers tag - do this if you want to become the owner or maintainer of an estimator you added.
  • The PR title starts with either [ENH], [MNT], [DOC], or [BUG]. [BUG] - bugfix, [MNT] - CI, test framework, [ENH] - adding or improving code, [DOC] - writing or improving documentation or docstrings.

@NAME-ASHWANIYADAV

Copy link
Copy Markdown
Contributor Author

@jgyasu @fkiraly PTAL !!

@fkiraly fkiraly left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks accurate, all correctly fixed! Thanks!

@fkiraly
fkiraly merged commit c992eca into sktime:main Jul 10, 2026
37 checks passed
@NAME-ASHWANIYADAV

Copy link
Copy Markdown
Contributor Author

thank you !! @fkiraly

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.

[DOC] Fix docstrings and typos in benchmarking module

2 participants