Merge pull request #224 from Remi-Gau/spell

[FIX] fix spelling

Author: Remi-Gau

.codespellrc

@@ -0,0 +1,4 @@
+[codespell]
+skip = .git,env,*build,lib
+ignore-words-list = ans
+builtin = clear,rare

.github/workflows/codespell.yml

@@ -0,0 +1,19 @@
+name: codespell
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  # Check for common misspellings
+  codespell:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: codespell-project/actions-codespell@master

notebooks/basic_usage.ipynb

@@ -268,7 +268,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Preparing your data dictionnary\n",
+    "### Preparing your data dictionary\n",
     "\n",
     "We can then initialize our logfile."
    ]
@@ -434,7 +434,7 @@
     "\n",
     "- A `_date-YYYYMMDDHHMM` suffix is appended to the file name. This is NOT accepted by the BIDS filenaming convention. This was introduced to prevent overwriting files by mistake in case some things were re-run. When you convert the source data into raw data, this date suffix should be removed (the `removeDataSuffix` is there for that).\n",
     "\n",
-    "- A json file that stores your data dictionnary was created.\n",
+    "- A json file that stores your data dictionary was created.\n",
     "\n",
     "Let's inpsect its content."
    ]

notebooks/creating_BIDS_dataset.ipynb

@@ -272,7 +272,7 @@
    "source": [
     "### Saving a `_bold.json` file\n",
     "\n",
-    "There is bare minimum functionality to create a `_bold.json` file for fMRI runs: the information in there wil be that required to pass a BIDS validation but no more. You should REALLY get most of the information for `bold.json` from your favorite DICOM to Nifti converter\n",
+    "There is bare minimum functionality to create a `_bold.json` file for fMRI runs: the information in there will be that required to pass a BIDS validation but no more. You should REALLY get most of the information for `bold.json` from your favorite DICOM to Nifti converter\n",
     "\n",
     "This function is there because it can help put in JSON format some of the information that would NOT be available to a converter (usually information about your task)."
    ]
@@ -355,7 +355,7 @@
    "source": [
     "%% Timing info\n",
     "\n",
-    "% Time between blocs in secs\n",
+    "% Time between blocks in secs\n",
     "parameters.timing.IBI = 1.8 * 3; % 8;\n",
     "% Time between events in secs\n",
     "parameters.timing.ISI = 0.1;\n",

notebooks/saving_stim_files.ipynb

@@ -233,7 +233,7 @@
    "source": [
     "## Inspect the content of the stim.tsv file\n",
     "    \n",
-    "The `onset`, `duration` and `trial_type` are ignored because they were note spcified in the `extraColumns` field.\n"
+    "The `onset`, `duration` and `trial_type` are ignored because they were note specified in the `extraColumns` field.\n"
    ]
   },
   {

src/checkCFG.m

@@ -51,12 +51,12 @@
     %     - ``cfg.fileName.task = ''``
     %       sets the name to be given to the task
     %     - ``cfg.fileName.zeroPadding = 3``
-    %       sets tha amount of 0 padding the subject, session and run number.
+    %       sets the amount of 0 padding the subject, session and run number.
     %     - ``cfg.fileName.dateFormat = 'yyyymmddHHMM'``
     %       sets the format of the date and time stamp that will be appended to all files.
     %
     %     The following fields can be used to specify certain of the labels that are used
-    %     to specify certain of the acquisition conditions of certain experemental runs
+    %     to specify certain of the acquisition conditions of certain experimental runs
     %     in a BIDS data set. These are mostly for MRI and, if set, will be ignored
     %     for most other modalities. See ``tests/test_createFilename()`` for details on how
     %     to use these.

src/convertSourceToRaw.m

@@ -39,7 +39,7 @@ function convertSourceToRaw(varargin)
     rawDir = fullfile(cfg.dir.output, 'raw');
 
     % back up description to not overwrite
-    % TODO bids malab should be smart enought to not do that
+    % TODO bids malab should be smart enough to not do that
     isFile = @(x) exist(x, 'file');
     if isFile(fullfile(rawDir, 'dataset_description.json'))
         copyfile(fullfile(rawDir, 'dataset_description.json'), ...

src/createJson.m

@@ -3,7 +3,7 @@ function createJson(varargin)
     % Creates the side car JSON file for a run.
     %
     % For JSON sidecars for bold files, this will only contain the minimum BIDS
-    % requirement and will likey be less complete than the info you could from
+    % requirement and will likely be less complete than the info you could from
     % a proper BIDS conversion.
     %
     % USAGE::

src/readAndFilterLogfile.m

@@ -30,7 +30,7 @@
     % :type tsvFile: string
     %
     % :param cfg: Configuration. See ``checkCFG()``. If ``cfg`` is given as input the name
-    %             of the TSV file to read will be infered from there.
+    %             of the TSV file to read will be inferred from there.
     % :type cfg: structure
     %
     % :returns:

src/utils/getFullFilename.m

@@ -1,6 +1,6 @@
 function fullFilename = getFullFilename(fileName, cfg)
     %
-    % Returns the full path of a file (fo a given subject and modality in a run).
+    % Returns the full path of a file (for a given subject and modality in a run).
     %
     % USAGE::
     %