[DOC] Add usage examples to core function docstrings (Fixes #1538)#1689
Open
Abhishek9639 wants to merge 2 commits intoopenml:mainfrom
Open
[DOC] Add usage examples to core function docstrings (Fixes #1538)#1689Abhishek9639 wants to merge 2 commits intoopenml:mainfrom
Abhishek9639 wants to merge 2 commits intoopenml:mainfrom
Conversation
66b3fc9 to
7126344
Compare
Author
geetu040
suggested changes
Feb 23, 2026
Collaborator
geetu040
left a comment
There was a problem hiding this comment.
Please fix the code quality checks, here is the guide
http://openml.github.io/openml-python/latest/developer_setup/#4-configure-quality-gates
c93d964 to
2e455d1
Compare
Author
|
Hii @geetu040, |
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
Details
This PR adds usage examples to selected public core functions in the project
to improve developer experience and documentation clarity.
The following functions were updated with example usage sections:
Why this change is necessary:
Examples in docstrings help users understand how to use the functions directly
from IDE hover tooltips and improve auto-generated documentation.
Reproduction:
No bug reproduction is required. This is a documentation enhancement.
Additional Notes:
Only docstrings were modified. No functional code changes were made.