Skip to content

Commit 37e151d

Browse files
authored
Apply Repo-Review rules (#3592)
## Changes proposed in this pull request * PC170: Uses PyGrep hooks (only needed if rST present) * PC191: Ruff show fixes if fixes enabled * PC903: Specified pre-commit CI schedule * ~~PP006: The dev dependency group should be defined~~ (it looks like the tox/uv combination cannot support PEP 735 out-of-the-box) ## Documentation that should be reviewed <!-- Please summarize here the main changes to the documentation that the reviewers should be aware of. --> <!-- Welcome, new contributors! We ask you to read through the Contributing Guide: https://github.com/nipreps/fmriprep/blob/master/CONTRIBUTING.md These are guidelines intended to make communication easier by describing a consistent process, but don't worry if you don't get it everything exactly "right" on the first try. To boil it down, here are some highlights: 1) Consider starting a conversation in the issues list before submitting a pull request. The discussion might save you a lot of time coding. 2) Please use descriptive prefixes in your pull request title, such as "ENH:" for an enhancement or "FIX:" for a bug fix. (See the Contributing guide for the full set.) And consider adding a "WIP" tag for works-in-progress. 3) Any code you submit will be licensed under the same terms (Apache License 2.0) as the rest of fMRIPrep. 4) We invite every contributor to add themselves to the `.zenodo.json` file (https://github.com/nipreps/fmriprep/blob/master/.zenodo.json), which will result in your being listed as an author at the next release. Please add yourself as the next-to-last entry, just above Russ. A pull request is a conversation. We may ask you to make some changes before accepting your PR, and likewise, you should feel free to ask us any questions you have. -->
2 parents b7077c0 + 544bbbb commit 37e151d

File tree

4 files changed

+16
-7
lines changed

4 files changed

+16
-7
lines changed

.pre-commit-config.yaml

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,18 @@ repos:
1111
- id: check-json
1212
- id: check-toml
1313
- id: check-added-large-files
14+
- repo: https://github.com/pre-commit/pygrep-hooks
15+
rev: v1.10.0
16+
hooks:
17+
- id: rst-backticks
18+
exclude: ^CHANGES.rst
19+
- id: rst-directive-colons
20+
- id: rst-inline-touching-normal
1421
- repo: https://github.com/astral-sh/ruff-pre-commit
1522
rev: v0.14.10
1623
hooks:
1724
- id: ruff-check
18-
args: [ --fix ]
25+
args: [ --fix, --show-fixes ]
1926
- id: ruff-format
27+
ci:
28+
autoupdate_schedule: monthly

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. fmriprep documentation master file, created by
22
sphinx-quickstart on Mon May 9 09:04:25 2016.
33
You can adapt this file completely to your liking, but it should at least
4-
contain the root `toctree` directive.
4+
contain the root ``toctree`` directive.
55
66
.. include:: links.rst
77
.. include:: ../README.rst

docs/spaces.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Therefore, *fMRIPrep* will run nonlinear registration processes against the temp
4545
T1w image corresponding to all the standard spaces supplied with the argument
4646
``--output-spaces``.
4747
By default, *fMRIPrep* will resample the preprocessed data on those spaces (labeling the
48-
corresponding outputs with the `space-<template-identifier>` BIDS entity) but keeping
48+
corresponding outputs with the ``space-<template-identifier>`` BIDS entity) but keeping
4949
the original resolution of the BOLD data to produce smaller files, more consistent with
5050
the original data gridding.
5151
However, many users will be interested in utilizing a coarse gridding (typically 2mm isotropic)

docs/workflows.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -445,8 +445,8 @@ No action is required by users, as this module is included in *fMRIPrep*.
445445
Details about the BIDS specification for field maps can be found at
446446
<https://bids-specification.readthedocs.io/en/stable/04-modality-specific-files/01-magnetic-resonance-imaging-data.html#types-of-fieldmaps>
447447

448-
**NOTE** SDCFlows prefers `B0FieldIdentifier`/`B0FieldSource` and will use that
449-
to the exclusion of `IntendedFor`, if it is present anywhere in the dataset.
448+
**NOTE** SDCFlows prefers ``B0FieldIdentifier``/``B0FieldSource`` and will use that
449+
to the exclusion of ``IntendedFor``, if it is present anywhere in the dataset.
450450

451451
For more detailed documentation on
452452
:abbr:`SDC (susceptibility-derived distortion correction)`
@@ -597,7 +597,7 @@ HCP Grayordinates
597597
)
598598

599599
If CIFTI output is enabled, the motion-corrected functional timeseries (in T1w space) is
600-
resampled onto the subject-native surface, optionally using the `HCP Pipelines_`'s
600+
resampled onto the subject-native surface, optionally using the `HCP Pipelines`_'s
601601
"goodvoxels" masking method to exclude voxels with local peaks of temporal variation.
602602
After dilating the surface-sampled time series to fill sampling holes, the result is
603603
resampled to the ``fsLR`` mesh (with the left and right hemisphere aligned).
@@ -627,7 +627,7 @@ Confounds estimation
627627
)
628628

629629
Given a motion-corrected fMRI, a brain mask, ``mcflirt`` movement parameters and a
630-
segmentation, the `discover_wf` sub-workflow calculates potential
630+
segmentation, the ``discover_wf`` sub-workflow calculates potential
631631
confounds per volume.
632632

633633
Calculated confounds include the mean global signal, mean tissue class signal,

0 commit comments

Comments
 (0)