Skip to content

Commit

Permalink
lint(codespell): docs and examples.
Browse files Browse the repository at this point in the history
  • Loading branch information
paquiteau committed Oct 16, 2024
1 parent fa1df49 commit 5c4a533
Show file tree
Hide file tree
Showing 6 changed files with 7 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/misc/development.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Developing SNAKE {#developing-snake}
## Developement environment {#developement-environment}
## Development environment {#developement-environment}

We recommend to use a virtual environment, and install SNAKE-FMRI and
its dependencies in it.
Expand Down
2 changes: 1 addition & 1 deletion docs/mrd-simulation.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The SNAKE MRD file structure is as follows:

- `header` group: contains the metadata for the file, as well as serialized information for the simulation.
- `acquisition` group: contains the raw k-space data and the acquisition parameters.
- `images` group: contains the static informations for the simulation (phantom, coil sensitivity maps, etc.).
- `images` group: contains the static information for the simulation (phantom, coil sensitivity maps, etc.).
- `waveforms` group: contains the dynamic information for the simulation (motion, physiological noise, etc.).


Expand Down
2 changes: 1 addition & 1 deletion examples/example_T2s_EPI.py
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@
# This is available in the companion package ``snake.toolkit``.
#
# Loading the ``.mrd`` file to retrieve all information can be done using the
# ``ismrmd`` python package, but SNAKE provides convient dataloaders, which are
# ``ismrmd`` python package, but SNAKE provides convenient dataloaders, which are
# more efficient, and take cares of managing underlying files access. As we are
# showcasing the API, we will do things manually here, and use only core SNAKE.

Expand Down
4 changes: 2 additions & 2 deletions examples/example_anat_EPI.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
#
# The simulation acquires
# the data describe in a phantom. A phantom consists of fuzzy segmentation of
# head tissue, and their MR intrisic parameters
# head tissue, and their MR intrinsic parameters
# (density, T1, T2, T2*, magnetic susceptibilities)
#
# Here we use Brainweb reference mask and values for convenience.
Expand Down Expand Up @@ -124,7 +124,7 @@
# This is available in the companion package ``snake.toolkit``.
#
# Loading the ``.mrd`` file to retrieve all information can be done using the
# ``ismrmd`` python package, but SNAKE provides convient dataloaders, which are
# ``ismrmd`` python package, but SNAKE provides convenient dataloaders, which are
# more efficient, and take cares of managing underlying files access. As we are
# showcasing the API, we will do things manually here, and use only core SNAKE.

Expand Down
2 changes: 1 addition & 1 deletion examples/example_gpu_anat_spirals.py
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@
# This is available in the companion package ``snake.toolkit``.
#
# Loading the ``.mrd`` file to retrieve all information can be done using the
# ``ismrmd`` python package, but SNAKE provides convient dataloaders, which are
# ``ismrmd`` python package, but SNAKE provides convenient dataloaders, which are
# more efficient, and take cares of managing underlying files access. As we are
# showcasing the API, we will do things manually here, and use only core SNAKE.

Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -141,3 +141,4 @@ exclude = ["examples/"]

[tool.codespell]
ignore-words-list = ["TE","fpr"]
skip = ["docs/generated", "*.ipynb"]

0 comments on commit 5c4a533

Please sign in to comment.