Improve documentation #290
Merged
Conversation
This file contains 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
mattcieslak
approved these changes
Jan 31, 2024
| is an optional dependency of ``CuBIDS``, we use it here to demonstrate its | ||
| powerful integration with ``CuBIDS`` and the benefits it can provide its users. | ||
| conda environment titled "cubids". | ||
| In this example, we use validator version ``1.7.2``. |
There was a problem hiding this comment.
Roughly 3 years old. Probably a good idea to update the example and notebooks at some point.
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## main #290 +/- ##
==========================================
+ Coverage 62.02% 62.13% +0.11%
==========================================
Files 8 9 +1
Lines 1572 1582 +10
==========================================
+ Hits 975 983 +8
- Misses 597 599 +2 ☔ View full report in Codecov by Sentry. |
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.
Closes none. One slightly, but not meaningfully, breaking change is that the
CuBIDSclass is no longer accessible throughcubids(i.e., you can't dofrom cubids import CuBIDS). Instead, you need the submodule now (from cubids.cubids import CuBIDS).Changes proposed: