Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

[DOC]: Add missing types in DataGrabber types docstrings #330

Merged
merged 2 commits into from
Apr 30, 2024

Conversation

synchon
Copy link
Member

@synchon synchon commented Apr 15, 2024

Which element of the documentation do you want to modify and why?

types: {"BOLD", "BOLD_confounds", "T1w", "VBM_CSF", "VBM_GM", \
"VBM_WM", "DWI"} or a list of the options, optional

vs

"BOLD_confounds": {
"pattern": (
"derivatives/fmriprep/{subject}/func/"
"{subject}_task-moviewatching_"
"desc-confounds_regressors.tsv"
),
"format": "fmriprep",
},
"BOLD_mask": {
"pattern": (
"derivatives/fmriprep/{subject}/func/"
"{subject}_task-moviewatching_"
"space-MNI152NLin2009cAsym_"
"desc-brain_mask.nii.gz"
),
"space": "MNI152NLin2009cAsym",
},
"T1w": {

Anything else to say?

No response

@fraimondo fraimondo added documentation Improvements or additions to documentation triage New issues waiting to be reviewed labels Apr 12, 2024
@synchon synchon changed the title [BUG]: DataladAOMICID1000 does not document BOLD_mask type [DOC]: DataladAOMICID1000 does not document BOLD_mask type Apr 15, 2024
@synchon synchon changed the title [DOC]: DataladAOMICID1000 does not document BOLD_mask type [DOC]: Add missing types in DataGrabber types docstrings Apr 15, 2024
@synchon synchon removed the triage New issues waiting to be reviewed label Apr 15, 2024
@synchon synchon requested a review from fraimondo April 15, 2024 08:41
@synchon synchon added this to the 0.0.5 (alpha 4) milestone Apr 15, 2024
Copy link

codecov bot commented Apr 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (6901c03) to head (a7c5573).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff            @@
##              main      #330   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            1         1           
  Lines            1         1           
=========================================
  Hits             1         1           
Flag Coverage Δ
docs 100.00% <ø> (ø)

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

Copy link

github-actions bot commented Apr 15, 2024

PR Preview Action v1.4.7
Preview removed because the pull request was closed.
2024-04-30 10:41 UTC

@synchon synchon force-pushed the chore/missing-type-docs branch from 4fa9be5 to a7c5573 Compare April 30, 2024 09:32
@synchon synchon merged commit 8f96159 into main Apr 30, 2024
24 of 28 checks passed
@synchon synchon deleted the chore/missing-type-docs branch April 30, 2024 10:09
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants