[FIX/STY] Standardize docstrings and add/fix doctests in AFNI interface. #1680
Conversation
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
Also standardize docstrings. Remove a couple of unused imports. Many cmdline doctests are still missing.
- Remove example_data() call in Bandpass doctest. - Add several skipped run doctests. - Remove unnecessary position requirements in FourierInputSpec, TCorrelateInputSpec - Add retrend argument to Fourier. - Adding cmdline doctest to TCorrMap revealed that it’s breaking. - Changed BrickStatInputSpec from AFNICommandInputSpec to CommandLineInputSpec and BrickStat from AFNICommand to AFNICommandBase because BrickStat returns a value instead of outputting a file. I haven’t checked that aggregate_outputs actually returns the value. - Fixed Eval doctest (was using Calc doctest). - Fixed MaskTool doctest (was using Automask doctest). - Changed TCat argument rlt from Str to Enum, since there are only three possible options (rlt, rlt+, rlt++).
- Also, skip cmdline doctest for TCorrMap, for now.
Current coverage is 70.83% (diff: 85.71%)@@ master #1680 diff @@
==========================================
Files 1030 1030
Lines 51771 51770 -1
Methods 0 0
Messages 0 0
Branches 7329 7329
==========================================
+ Hits 36666 36671 +5
+ Misses 14018 14009 -9
- Partials 1087 1090 +3
|
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.
Changes across AFNI interface:
Specific changes:
TCorrelateInputSpec
CommandLineInputSpec and BrickStat from AFNICommand to AFNICommandBase
because BrickStat returns a value instead of outputting a file. I
haven’t checked that aggregate_outputs actually returns the value.
three possible options (rlt, rlt+, rlt++).
This PR should resolve #1499.