Skip to content

Added an example and improved docstring for load_sample#715

Open
kennethshsu wants to merge 4 commits intomainfrom
#704
Open

Added an example and improved docstring for load_sample#715
kennethshsu wants to merge 4 commits intomainfrom
#704

Conversation

@kennethshsu
Copy link
Copy Markdown
Collaborator

@kennethshsu kennethshsu commented Apr 24, 2026

What does this pull request do?

Improved the doctoring and added an example

Relevent Github ticket(s)?

#704


Note

Low Risk
Low risk since changes are documentation-only and do not alter load_sample behavior or data loading logic.

Overview
Updates the load_sample docstring to clarify that dataset keys are case-insensitive, enumerate commonly used and all available built-in sample datasets, and include a Sphinx .. testcode:: example showing how to load raa and the expected output.

Reviewed by Cursor Bugbot for commit aec82e9. Bugbot is set up for automated code reviews on this repo. Configure here.

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 24, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.12%. Comparing base (6ea3577) to head (aec82e9).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #715   +/-   ##
=======================================
  Coverage   85.12%   85.12%           
=======================================
  Files          85       85           
  Lines        4909     4909           
  Branches      629      629           
=======================================
  Hits         4179     4179           
  Misses        521      521           
  Partials      209      209           
Flag Coverage Δ
unittests 85.12% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ 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.

@kennethshsu
Copy link
Copy Markdown
Collaborator Author

@genedan you can hold off on this too, I'll need to update before this can be reviewed and merged.

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.

1 participant