juaml/junifer
Watch
3
0
Fork
You've already forked junifer
 0
Code Issues 14 Pull requests 2 Packages Activity Actions

[ENH]: Shorten Sphinx references in codebase #218

Merged
synchon merged 62 commits from chore/shorten-sphinx-ref into main 2023-03-31 12:47:53 +00:00
Conversation 7 Commits 62 Files changed 61 +249 -259
synchon commented 2023-03-31 11:50:56 +00:00 (Migrated from github.com)
Copy link
  • fix #(issue number)
  • description of feature/fix
  • tests added/passed
  • add an entry for the latest changes

This PR shortens Sphinx references used throughout code and docs. Also, runs black and adds a shield for it in README.md.

* [ ] fix #(issue number) * [x] description of feature/fix * [x] tests added/passed * [x] add an entry for the latest changes This PR shortens Sphinx references used throughout code and docs. Also, runs `black` and adds a shield for it in `README.md`.
fraimondo (Migrated from github.com) reviewed 2023-03-31 11:50:56 +00:00
codecov[bot] commented 2023-03-31 11:51:48 +00:00 (Migrated from github.com)
Copy link

Codecov Report

Merging #218 (1c3b323) into main (ace98da) will increase coverage by 0.30%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #218      +/-   ##
==========================================
+ Coverage   93.30%   93.60%   +0.30%     
==========================================
  Files          79       80       +1     
  Lines        3403     3458      +55     
  Branches      642      653      +11     
==========================================
+ Hits         3175     3237      +62     
+ Misses        150      144       -6     
+ Partials       78       77       -1
Flag Coverage Δ
docs 100.00% <ø> (ø)
junifer 93.60% <100.00%> (+0.31%) ⬆️
mock ?

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

Impacted Files Coverage Δ
junifer/data/parcellations.py 98.09% <ø> (ø)
junifer/markers/ets_rss.py 100.00% <ø> (ø)
junifer/markers/falff/falff_estimator.py 95.50% <ø> (+0.05%) ⬆️
junifer/markers/falff/falff_parcels.py 100.00% <ø> (ø)
junifer/markers/falff/falff_spheres.py 100.00% <ø> (ø)
...nnectivity/edge_functional_connectivity_parcels.py 100.00% <ø> (ø)
...nnectivity/edge_functional_connectivity_spheres.py 89.47% <ø> (ø)
...ional_connectivity/functional_connectivity_base.py 97.05% <ø> (ø)
...al_connectivity/functional_connectivity_parcels.py 100.00% <ø> (ø)
...al_connectivity/functional_connectivity_spheres.py 100.00% <ø> (ø)
... and 13 more

... and 12 files with indirect coverage changes

## [Codecov](https://codecov.io/gh/juaml/junifer/pull/218?src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) Report > Merging [#218](https://codecov.io/gh/juaml/junifer/pull/218?src=pr&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) (1c3b323) into [main](https://codecov.io/gh/juaml/junifer/commit/ace98da340e20cffcd2a5d939ff0d57afe4451d0?el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) (ace98da) will **increase** coverage by `0.30%`. > The diff coverage is `100.00%`. [![Impacted file tree graph](https://codecov.io/gh/juaml/junifer/pull/218/graphs/tree.svg?width=650&height=150&src=pr&token=5H21JuZXMw&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml)](https://codecov.io/gh/juaml/junifer/pull/218?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) ```diff @@ Coverage Diff @@ ## main #218 +/- ## ========================================== + Coverage 93.30% 93.60% +0.30% ========================================== Files 79 80 +1 Lines 3403 3458 +55 Branches 642 653 +11 ========================================== + Hits 3175 3237 +62 + Misses 150 144 -6 + Partials 78 77 -1 ``` | Flag | Coverage Δ | | |---|---|---| | docs | `100.00% <ø> (ø)` | | | junifer | `93.60% <100.00%> (+0.31%)` | :arrow_up: | | mock | `?` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#carryforward-flags-in-the-pull-request-comment) to find out more. | [Impacted Files](https://codecov.io/gh/juaml/junifer/pull/218?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) | Coverage Δ | | |---|---|---| | [junifer/data/parcellations.py](https://codecov.io/gh/juaml/junifer/pull/218?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#diff-anVuaWZlci9kYXRhL3BhcmNlbGxhdGlvbnMucHk=) | `98.09% <ø> (ø)` | | | [junifer/markers/ets\_rss.py](https://codecov.io/gh/juaml/junifer/pull/218?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#diff-anVuaWZlci9tYXJrZXJzL2V0c19yc3MucHk=) | `100.00% <ø> (ø)` | | | [junifer/markers/falff/falff\_estimator.py](https://codecov.io/gh/juaml/junifer/pull/218?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#diff-anVuaWZlci9tYXJrZXJzL2ZhbGZmL2ZhbGZmX2VzdGltYXRvci5weQ==) | `95.50% <ø> (+0.05%)` | :arrow_up: | | [junifer/markers/falff/falff\_parcels.py](https://codecov.io/gh/juaml/junifer/pull/218?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#diff-anVuaWZlci9tYXJrZXJzL2ZhbGZmL2ZhbGZmX3BhcmNlbHMucHk=) | `100.00% <ø> (ø)` | | | [junifer/markers/falff/falff\_spheres.py](https://codecov.io/gh/juaml/junifer/pull/218?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#diff-anVuaWZlci9tYXJrZXJzL2ZhbGZmL2ZhbGZmX3NwaGVyZXMucHk=) | `100.00% <ø> (ø)` | | | [...nnectivity/edge\_functional\_connectivity\_parcels.py](https://codecov.io/gh/juaml/junifer/pull/218?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#diff-anVuaWZlci9tYXJrZXJzL2Z1bmN0aW9uYWxfY29ubmVjdGl2aXR5L2VkZ2VfZnVuY3Rpb25hbF9jb25uZWN0aXZpdHlfcGFyY2Vscy5weQ==) | `100.00% <ø> (ø)` | | | [...nnectivity/edge\_functional\_connectivity\_spheres.py](https://codecov.io/gh/juaml/junifer/pull/218?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#diff-anVuaWZlci9tYXJrZXJzL2Z1bmN0aW9uYWxfY29ubmVjdGl2aXR5L2VkZ2VfZnVuY3Rpb25hbF9jb25uZWN0aXZpdHlfc3BoZXJlcy5weQ==) | `89.47% <ø> (ø)` | | | [...ional\_connectivity/functional\_connectivity\_base.py](https://codecov.io/gh/juaml/junifer/pull/218?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#diff-anVuaWZlci9tYXJrZXJzL2Z1bmN0aW9uYWxfY29ubmVjdGl2aXR5L2Z1bmN0aW9uYWxfY29ubmVjdGl2aXR5X2Jhc2UucHk=) | `97.05% <ø> (ø)` | | | [...al\_connectivity/functional\_connectivity\_parcels.py](https://codecov.io/gh/juaml/junifer/pull/218?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#diff-anVuaWZlci9tYXJrZXJzL2Z1bmN0aW9uYWxfY29ubmVjdGl2aXR5L2Z1bmN0aW9uYWxfY29ubmVjdGl2aXR5X3BhcmNlbHMucHk=) | `100.00% <ø> (ø)` | | | [...al\_connectivity/functional\_connectivity\_spheres.py](https://codecov.io/gh/juaml/junifer/pull/218?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#diff-anVuaWZlci9tYXJrZXJzL2Z1bmN0aW9uYWxfY29ubmVjdGl2aXR5L2Z1bmN0aW9uYWxfY29ubmVjdGl2aXR5X3NwaGVyZXMucHk=) | `100.00% <ø> (ø)` | | | ... and [13 more](https://codecov.io/gh/juaml/junifer/pull/218?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) | | ... and [12 files with indirect coverage changes](https://codecov.io/gh/juaml/junifer/pull/218/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml)
github-actions[bot] commented 2023-03-31 11:56:22 +00:00 (Migrated from github.com)
Copy link
PR Preview Action v1.3.0
Preview removed because the pull request was closed.
2023-03-31 12:53 UTC
[PR Preview Action](https://github.com/rossjrw/pr-preview-action) v1.3.0 :---: Preview removed because the pull request was closed. 2023-03-31 12:53 UTC <!-- Sticky Pull Request Commentpr-preview -->
fraimondo (Migrated from github.com) requested changes 2023-03-31 12:11:40 +00:00
README.md
@ -7,6 +7,7 @@
![PyPI - Wheel](https://img.shields.io/pypi/wheel/junifer?style=flat-square)
fraimondo (Migrated from github.com) commented 2023-03-31 12:09:25 +00:00
Copy link

There's an error here.

There's an error here.
docs/extending/datagrabber.rst
@ -186,29 +186,28 @@ in the yaml file to ``ExampleBIDSDataGrabber``. Remember that we still need to
set the ``datadir``.
fraimondo (Migrated from github.com) commented 2023-03-31 12:10:41 +00:00
Copy link

This is on purpose for educational purposes?

This is on purpose for educational purposes?
synchon (Migrated from github.com) reviewed 2023-03-31 12:18:06 +00:00
docs/extending/datagrabber.rst
@ -186,29 +186,28 @@ in the yaml file to ``ExampleBIDSDataGrabber``. Remember that we still need to
set the ``datadir``.
synchon (Migrated from github.com) commented 2023-03-31 12:18:06 +00:00
Copy link

What do you mean?

What do you mean?
fraimondo (Migrated from github.com) reviewed 2023-03-31 12:19:46 +00:00
docs/extending/datagrabber.rst
@ -186,29 +186,28 @@ in the yaml file to ``ExampleBIDSDataGrabber``. Remember that we still need to
set the ``datadir``.
fraimondo (Migrated from github.com) commented 2023-03-31 12:19:46 +00:00
Copy link

it has the full reference: ~junifer.datagrabber.PatternDataladDataGrabber

it has the full reference: ``~junifer.datagrabber.PatternDataladDataGrabber``
synchon (Migrated from github.com) reviewed 2023-03-31 12:21:11 +00:00
docs/extending/datagrabber.rst
@ -186,29 +186,28 @@ in the yaml file to ``ExampleBIDSDataGrabber``. Remember that we still need to
set the ``datadir``.
synchon (Migrated from github.com) commented 2023-03-31 12:21:11 +00:00
Copy link

Yeah missed that, good catch, thanks!

Yeah missed that, good catch, thanks!
Sign in to join this conversation.
Reviewers
No reviewers
fraimondo
Labels
Clear labels   
CRITICAL
High Priority Issue

  
Stale

   
WIP
Work in progress

  
bug
Something isn't working

  
concept
Design/Implementation concepts

  
coordinate
Issues or pull requests related to coordinates (ROIs)

  
dataset
Issues or pull requests related to datagrabbers or datasets

  
dependencies
Pull requests that update a dependency file

  
documentation
Improvements or additions to documentation

  
duplicate
This issue or pull request already exists

  
enhancement
New feature or request

  
github_actions
Pull requests that update GitHub Actions code

  
good first issue
Good for newcomers

  
help wanted
Extra attention is needed

  
invalid
This doesn't seem right

  
maintenance
Issues or pull requests related to maintenance

  
maps
Issues or pull requests related to maps (probabilistic atlases)

  
marker
Issues or pull requests related to markers

  
mask
Issues or pull requests related to masks

  
on hold
Issue waiting on other issue(s)

  
parcellation
Issues or pull requests related to parcellations (deterministic atlases)

  
preprocess
Issues or pull requests related to preprocessors

  
question
Further information is requested

  
ready
Pull request is ready for review and merge

  
storage
Issues or pull requests related to marker storage or retrieval

  
template-space
Issues or pull requests related to template spaces

  
triage
New issues waiting to be reviewed

  
wontfix
This will not be worked on

No labels
CRITICAL
Stale
WIP
bug
concept
coordinate
dataset
dependencies
documentation
duplicate
enhancement
github_actions
good first issue
help wanted
invalid
maintenance
maps
marker
mask
on hold
parcellation
preprocess
question
ready
storage
template-space
triage
wontfix
Milestone
Clear milestone
No items
No milestone
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
juaml/junifer!218
No description provided.