[DOC] Complete testing framework documentation page#525
Open
direkkakkar319-ops wants to merge 3 commits intosktime:mainfrom
Open
[DOC] Complete testing framework documentation page#525direkkakkar319-ops wants to merge 3 commits intosktime:mainfrom
direkkakkar319-ops wants to merge 3 commits intosktime:mainfrom
Conversation
Author
fkiraly
requested changes
Mar 14, 2026
Contributor
fkiraly
left a comment
There was a problem hiding this comment.
This is great, but please do not use AI indiscriminately.
- do not change unrelated parts of the documentation, e.g., minuscule reformats or random deletions
- it would be great if you distinguished the tests for
scikit-baseitself, and the test framework that can be used for third party libraries.
efb1663 to
c0de739
Compare
for more information, see https://pre-commit.ci
Author
|
hi, @fkiraly , added distinguished the tests for scikit-base and removed the unrelated parts . |
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.
Reference Issues/PRs
Fixes #524
What does this implement/fix? Explain your changes.
The testing framework documentation page was explicitly marked as
"under construction" with only 3 bullet points and no real content.
The page
docs/source/contribute/development/developer_guide/testing_framework.rsthas been completely rewritten (~290 lines) covering:
with naming conventions
skbase.testingmodule — detailed docs forBaseFixtureGenerator,QuickTester, andTestAllObjectsget_test_params,create_test_instance,create_test_instances_and_names, andrun_testsBaseObjectsubclassNo index changes were needed —
testing_framework.rstwas alreadylinked in
developer_guide.rst(toctree line 16, card button line 101).doc8linter passes with 0 errors.Does your contribution introduce a new dependency? If yes, which one?
No new dependencies introduced. This is a documentation-only change.
What should a reviewer concentrate their feedback on?
how
BaseFixtureGenerator,QuickTesterandTestAllObjectswork?missing and should be added?
contributors?
Any other comments?
Since
skbase.testingis one of skbase's four core submodules, havingno real documentation for it was one of the most impactful gaps for new
contributors. This PR addresses that fully.
PR checklist
For all contributions
the PR topic is related to enhancement, CI/CD, maintenance, documentation, or a bug.
For code contributions