Fix tutorials (part I) #41
Open
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR aims to update the tutorials by cleaning up the fieldtrip tutorial and reinforcing the tutorial infrastructure.
- Added detailed docstrings to guide data retrieval functions.
- Introduced a new get_fieldtrip_metadata function to download tutorial metadata.
- Updated the module exports in init.py to include the new metadata function.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| pylabianca/utils/data.py | Added docstrings and a new function for metadata download support. |
| pylabianca/utils/init.py | Updated exports to include get_fieldtrip_metadata. |
Comments suppressed due to low confidence (2)
pylabianca/utils/data.py:60
- [nitpick] Consider renaming 'fname' to 'metadata_path' in get_fieldtrip_metadata for improved clarity about its content.
fname = pooch.retrieve(
pylabianca/utils/data.py:56
- Consider moving the hardcoded URL (and associated known hash) into module-level constants to facilitate easier maintenance and potential future updates.
file_url = ('https://www.dropbox.com/scl/fi/0snol5gx92kpzm1aqmb6f/monkey_stim.csv?rlkey=pfqcjg2tuaevbfjgntak5r7gm&st=nueys5na&dl=1')
Codecov ReportAttention: Patch coverage is @@ Coverage Diff @@
## main #41 +/- ##
=======================================
- Coverage 75.3% 75.2% -0.2%
=======================================
Files 18 18
Lines 3626 3633 +7
=======================================
+ Hits 2733 2734 +1
- Misses 893 899 +6 🚀 New features to boost your workflow:
|
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.
Make sure the tutorials are up to date.