Skip to content

Commit 2d8f895

Browse files
authored
Add codespell support (config, workflow to detect/not fix) and make it fix few typos (#43)
* Add github action to codespell mkdocs on push and PRs * Add rudimentary codespell config * Some ignores for codespell * [DATALAD RUNCMD] run codespell throughout fixing typos automagically === Do not change lines below === { "chain": [], "cmd": "codespell -w", "exit": 0, "extra_inputs": [], "inputs": [], "outputs": [], "pwd": "." } ^^^ Do not change lines above ^^^
1 parent bcc0caa commit 2d8f895

File tree

12 files changed

+41
-10
lines changed

12 files changed

+41
-10
lines changed

Diff for: .codespellrc

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[codespell]
2+
# Ref: https://github.com/codespell-project/codespell#using-a-config-file
3+
skip = .git*,*.pdf,*.svg,*.css,*.min.*,.codespellrc,*.js,*.cast
4+
check-hidden = true
5+
ignore-regex = <sup>nd</sup>
6+
# ignore-words-list =

Diff for: .github/workflows/codespell.yml

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Codespell configuration is within .codespellrc
2+
---
3+
name: Codespell
4+
5+
on:
6+
push:
7+
branches: [mkdocs]
8+
pull_request:
9+
branches: [mkdocs]
10+
11+
permissions:
12+
contents: read
13+
14+
jobs:
15+
codespell:
16+
name: Check for spelling errors
17+
runs-on: ubuntu-latest
18+
19+
steps:
20+
- name: Checkout
21+
uses: actions/checkout@v4
22+
- name: Annotate locations with typos
23+
uses: codespell-project/codespell-problem-matcher@v1
24+
- name: Codespell
25+
uses: codespell-project/actions-codespell@v2

Diff for: docs/apps/singularity.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ endpoints), then you can try the following:
246246

247247
* `requests.exceptions.SSLError: HTTPSConnectionPool ...`. In this case,
248248
your container seems to be able to reach the Internet, but unable to use
249-
SSL encription. There are two potential solutions to the issue. The
249+
SSL encryption. There are two potential solutions to the issue. The
250250
[recommended one](https://neurostars.org/t/problems-using-pediatric-template-from-templateflow/4566/17)
251251
is setting `REQUESTS_CA_BUNDLE` to the appropriate path, and/or binding
252252
the appropriate filesystem:

Diff for: docs/assets/EPFL2023/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -503,7 +503,7 @@
503503

504504
---
505505

506-
# Why standarizing?
506+
# Why standardizing?
507507

508508
.boxed-content[
509509
.distribute.large[

Diff for: docs/assets/OHBM2022/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -554,7 +554,7 @@
554554
*(... or the lack thereof)*
555555

556556
* *fMRIPrep* does not guarantee full run reproducibility with `--omp-nthreads` larger than 1
557-
* Which means, **disabling within-node paralellization**.
557+
* Which means, **disabling within-node parallelization**.
558558

559559
* *fMRIPrep* writes out a config file
560560
* stores **seeds** for all random number generators it has access to

Diff for: docs/assets/ORN-Workshop/presentation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ Therefore, it is better to keep things that way (although some minimal efforts t
290290

291291
## The *dMRIPrep* story
292292

293-
After the success of *fMRIPrep*, some neuroimagers asked "*when a diffussion MRI fMRIPrep?*"
293+
After the success of *fMRIPrep*, some neuroimagers asked "*when a diffusion MRI fMRIPrep?*"
294294

295295
## NeuroStars.org
296296
(please note this down)

Diff for: docs/assets/fmriprep-bootcamp-geneva2024/day1-01-fmriprep-primer/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -441,7 +441,7 @@
441441

442442
---
443443

444-
# The neuroimaging worflow
444+
# The neuroimaging workflow
445445

446446
<br />
447447
<br />

Diff for: docs/assets/torw2020/presentation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1072,7 +1072,7 @@ Such is the case of the quality control tools.
10721072

10731073
MRIQC produces visual reports for the efficient screening of acquired (meaning, unprocessed) data - in particular anatomical and functional MRI of the human brain.
10741074

1075-
CrowdMRI is an internet service where anonimized quality control metrics are uploaded automatically as they are computed by MRIQC.
1075+
CrowdMRI is an internet service where anonymized quality control metrics are uploaded automatically as they are computed by MRIQC.
10761076

10771077
The endgoal is to gather enough data to describe the normative distribution of these metrics across image parameters and scanning devices and sites.
10781078

Diff for: docs/community/CODE_OF_CONDUCT.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ In the interest of fostering an open and welcoming environment, we as
66
contributors and maintainers pledge to making participation in our project and
77
our community a harassment-free experience for everyone, regardless of age, body
88
size, disability, ethnicity, sex characteristics, gender identity and expression,
9-
level of experience, education, socio-economic status, nationality, personal
9+
level of experience, education, socioeconomic status, nationality, personal
1010
appearance, race, religion, or sexual identity and orientation.
1111

1212
## Our Standards

Diff for: docs/community/CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ but those accepted fastest will follow a workflow similar to the following:
232232
* `DOC`: new or updated documentation ([example][doc_ex])
233233
* `STY`: style changes ([example][sty_ex])
234234
* `REF`: refactoring existing code ([example][ref_ex])
235-
* `CI`: updates to continous integration infrastructure ([example][ci_ex])
235+
* `CI`: updates to continuous integration infrastructure ([example][ci_ex])
236236
* `MAINT`: general maintenance ([example][maint_ex])
237237
* For works-in-progress, add the `WIP` tag in addition to the descriptive prefix.
238238
Pull-requests tagged with `WIP:` will not be merged until the tag is removed.

Diff for: docs/community/licensing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Containerized Images bundling *NiPreps* components and their dependencies can be
3333
distributed under a free and open-source license without copyleft, such as the
3434
[MIT License](https://choosealicense.com/licenses/mit/).
3535
In such a case, the attribution notice of the MIT license must be present in the
36-
header comment of the container image bootstraping file (for instance, the so-called
36+
header comment of the container image bootstrapping file (for instance, the so-called
3737
`Dockerfile`).
3838
This different licensing must be also indicated in the `NOTICE` file of the corresponding
3939
*NiPreps* components bundled within the image.

Diff for: docs/devs/devenv.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ INFO - Not serving HTTPS
157157
Now you can switch to your favorite browser and go to: [127.0.0.1:8445](http://127.0.0.1:8445) (or [192.168.99.100:8445](http://192.168.99.100:8445) for Docker Toolbox).
158158

159159
**3. Copy `fmriprep.egg-info` into your `fmriprep/` project directory**
160-
`fmriprep.egg-info` makes the package exacutable inside the docker container.
160+
`fmriprep.egg-info` makes the package executable inside the docker container.
161161
Open a terminal in vscode and type the following:
162162

163163
```shell

0 commit comments

Comments
 (0)