Skip to content

[DOC] Update SelectFiles docstring to match actual behavior #3041

New issue

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

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

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 23, 2020

Conversation

kimsin98
Copy link
Contributor

@kimsin98 kimsin98 commented Sep 19, 2019

Summary

Fixes #2712 through clarification.

List of changes proposed in this PR (pull-request)

  • Clarifies that SelectFiles does not support lists as inputs.

Acknowledgment

  • (Mandatory) I acknowledge that this contribution will be available under the Apache 2 license.

>>> dg.inputs.run = [2, 4]
>>> dg.inputs.run = [10, 11]

would match f0.nii or f1.nii, not f10.nii or f11.nii.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh. I think I misunderstood #2712. I interpreted it as you saying that

templates["epi"] = "{subject_id}/func/f[10].nii"

would produce the result you describe. For the code above, I would have expected to match f10.nii and f11.nii.

Possibly @mwaskom can clarify whether this was the intended behavior, though it's been a long time since #623.

@effigies effigies added this to the 1.3.0 milestone Sep 20, 2019
@effigies effigies modified the milestones: 1.3.0, 1.4.0 Nov 11, 2019
@effigies effigies modified the milestones: 1.4.0, 1.4.1 Dec 18, 2019
Co-Authored-By: Oscar Esteban <[email protected]>
@codecov
Copy link

codecov bot commented Dec 30, 2019

Codecov Report

Merging #3041 into master will increase coverage by 2.64%.
The diff coverage is 20%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #3041      +/-   ##
==========================================
+ Coverage   67.53%   70.18%   +2.64%     
==========================================
  Files         344      345       +1     
  Lines       44093    66874   +22781     
  Branches     5555    10123    +4568     
==========================================
+ Hits        29779    46933   +17154     
- Misses      13560    18604    +5044     
- Partials      754     1337     +583
Flag Coverage Δ
#smoketests 50.33% <ø> (ø) ⬆️
#unittests 68.87% <20%> (+3.87%) ⬆️
Impacted Files Coverage Δ
nipype/interfaces/io.py 58.73% <20%> (+3.79%) ⬆️
nipype/interfaces/nilearn.py 75.25% <0%> (-21.41%) ⬇️
nipype/utils/spm_docs.py 56.75% <0%> (-13.62%) ⬇️
nipype/interfaces/freesurfer/base.py 68.71% <0%> (-11.8%) ⬇️
nipype/interfaces/dipy/stats.py 88.23% <0%> (-11.77%) ⬇️
nipype/interfaces/dipy/registration.py 88.88% <0%> (-11.12%) ⬇️
nipype/workflows/dmri/fsl/tbss.py 78.37% <0%> (-10.82%) ⬇️
nipype/workflows/smri/freesurfer/ba_maps.py 90.27% <0%> (-9.73%) ⬇️
nipype/algorithms/rapidart.py 55.87% <0%> (-8.55%) ⬇️
nipype/workflows/smri/freesurfer/recon.py 65.95% <0%> (-8.52%) ⬇️
... and 256 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f7d7a1c...2549ec1. Read the comment docs.

@effigies effigies modified the milestones: 1.4.1, 1.5.0 Jan 26, 2020
@effigies effigies mentioned this pull request Feb 23, 2020
17 tasks
@effigies effigies changed the title [DOC] SelectFiles docstring corrected [DOC] Update SelectFiles docstring to match actual behavior Feb 23, 2020
@effigies
Copy link
Member

Looks like we're not going to get clarification on intent, and making the docstring match historical behavior seems safer than fixing a potentially load-bearing bug.

@effigies effigies merged commit fa6dfbb into nipy:master Feb 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

SelectFiles doesn't accept lists as input
4 participants