Skip to content

[DOC] Enhance Docstrings of Flows Core Public Functions#1569

Merged
fkiraly merged 11 commits intoopenml:mainfrom
EmanAbdelhaleem:enhance-docstrings
Feb 15, 2026
Merged

[DOC] Enhance Docstrings of Flows Core Public Functions#1569
fkiraly merged 11 commits intoopenml:mainfrom
EmanAbdelhaleem:enhance-docstrings

Conversation

@EmanAbdelhaleem
Copy link
Copy Markdown
Contributor

@EmanAbdelhaleem EmanAbdelhaleem commented Dec 29, 2025

Metadata

Details

enhance the docstrings of flows core public functions, add examples, parameter default, parameter type..etc

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Dec 31, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 51.98%. Comparing base (aa04b30) to head (7efee3c).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff             @@
##             main    #1569       +/-   ##
===========================================
+ Coverage   23.12%   51.98%   +28.86%     
===========================================
  Files          36       36               
  Lines        4351     4351               
===========================================
+ Hits         1006     2262     +1256     
+ Misses       3345     2089     -1256     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@EmanAbdelhaleem EmanAbdelhaleem marked this pull request as ready for review January 8, 2026 21:29
Copy link
Copy Markdown
Collaborator

@SimonBlanke SimonBlanke left a comment

Choose a reason for hiding this comment

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

Good job. Just a few questions in the code.

Comment thread openml/flows/functions.py Outdated
Comment thread openml/flows/functions.py Outdated
Copy link
Copy Markdown
Collaborator

@geetu040 geetu040 left a comment

Choose a reason for hiding this comment

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

Good that you've added examples and they work. Some example require authentication but you don't need to mention explicitly, because the error message is descriptive enough.

@geetu040 geetu040 requested a review from SimonBlanke February 6, 2026 07:19
@fkiraly fkiraly merged commit 5b85b77 into openml:main Feb 15, 2026
31 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants