Skip to content

Commit bb012d6

Browse files
committed
doc: show defaults, make most defaults explicit
1 parent a294b49 commit bb012d6

File tree

2 files changed

+4
-8
lines changed

2 files changed

+4
-8
lines changed

docs/usage.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@ Command-Line Arguments
3535
.. argparse::
3636
:ref: fmriprep.cli.parser._build_parser
3737
:prog: fmriprep
38-
:nodefaultconst:
3938

4039

4140
The command-line interface of the docker wrapper
@@ -44,7 +43,6 @@ The command-line interface of the docker wrapper
4443
.. argparse::
4544
:ref: fmriprep_docker.__main__.get_parser
4645
:prog: fmriprep-docker
47-
:nodefaultconst:
4846

4947

5048

fmriprep/cli/parser.py

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -418,7 +418,7 @@ def _fallback_trt(value, parser):
418418
'--slice-time-ref',
419419
required=False,
420420
action='store',
421-
default=None,
421+
default=0.5,
422422
type=SliceTimeRef,
423423
help='The time of the reference slice to correct BOLD values to, as a fraction '
424424
'acquisition time. 0 indicates the start, 0.5 the midpoint, and 1 the end '
@@ -501,7 +501,6 @@ def _fallback_trt(value, parser):
501501
)
502502
g_conf.add_argument(
503503
'--project-goodvoxels',
504-
required=False,
505504
action='store_true',
506505
default=False,
507506
help='Exclude voxels whose timeseries have locally high coefficient of variation '
@@ -530,8 +529,7 @@ def _fallback_trt(value, parser):
530529
action=BooleanOptionalAction,
531530
default=True,
532531
dest='run_msmsulc',
533-
help='Enable or disable Multimodal Surface Matching surface registration. '
534-
'To disable, use `--no-msm`.',
532+
help='Enable or disable Multimodal Surface Matching surface registration.',
535533
)
536534

537535
g_confounds = parser.add_argument_group('Options relating to confounds')
@@ -645,8 +643,7 @@ def _fallback_trt(value, parser):
645643
action=BooleanOptionalAction,
646644
default=True,
647645
dest='hires',
648-
help='Enable or disable sub-millimeter (hi-res) reconstruction. '
649-
'To disable, use `--no-submm-recon`.',
646+
help='Enable or disable sub-millimeter (hi-res) reconstruction.',
650647
)
651648
g_fs.add_argument(
652649
'--fs-no-reconall',
@@ -665,6 +662,7 @@ def _fallback_trt(value, parser):
665662
g_carbon = parser.add_argument_group('Options for carbon usage tracking')
666663
g_carbon.add_argument(
667664
'--track-carbon',
665+
default=False,
668666
action='store_true',
669667
help='Tracks power draws using CodeCarbon package',
670668
)

0 commit comments

Comments
 (0)