[DOC] Update with the latest usage guide + missing metrics#126
Merged
Conversation
It points to an empty page.
Also update the share info in README.md and usage.md files.
We no longer use `black` in the project.
Collaborator
Author
|
@htwangtw , could you review this PR when you have some time? |
htwangtw
approved these changes
Jun 4, 2026
| ``` | ||
|
|
||
| 1. Make the changes in your branch. | ||
| 1. Run the tests locally to confirm your changes don’t break anything. See the [Testing](#running-tests) section below for details. |
Collaborator
There was a problem hiding this comment.
all these listed items start with 1️⃣
Collaborator
Author
There was a problem hiding this comment.
This is intended. The markdown render will automatically increment the item number (see attached img). It prevents having to change the item number when modifying the item order in the markdown; e.g. adding an item in an existing list.
Collaborator
There was a problem hiding this comment.
wowo this is a cool feature
htwangtw
reviewed
Jun 4, 2026
htwangtw
reviewed
Jun 4, 2026
mathdugre
force-pushed
the
doc/update
branch
2 times, most recently
from
a6051f2 to
6e05fc8
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #126 +/- ##
==========================================
- Coverage 54.03% 51.10% -2.93%
==========================================
Files 26 26
Lines 1414 1405 -9
==========================================
- Hits 764 718 -46
- Misses 650 687 +37 🚀 New features to boost your workflow:
|
Collaborator
Author
|
Hi @htwangtw , I made the requested changes and fixed the relevant tests. Let me know if you have feedback |
This is command that worked after debugging with Lea. It worked for both Clara and I during the Brainhack OHBM.
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
2 participants
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.
(1) I still cannot download the test data via DataLad #121. It either fails (see below) or download extremely slow (few bytes per seconds)