Added an example and improved docstring for load_sample#715
Open
kennethshsu wants to merge 4 commits intomainfrom
Open
Added an example and improved docstring for load_sample#715kennethshsu wants to merge 4 commits intomainfrom
kennethshsu wants to merge 4 commits intomainfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 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
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Collaborator
Author
|
@genedan you can hold off on this too, I'll need to update before this can be reviewed and merged. |
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.
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_samplebehavior or data loading logic.Overview
Updates the
load_sampledocstring 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 loadraaand the expected output.Reviewed by Cursor Bugbot for commit aec82e9. Bugbot is set up for automated code reviews on this repo. Configure here.