diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml new file mode 100644 index 000000000..3ebbf5504 --- /dev/null +++ b/.github/workflows/codespell.yml @@ -0,0 +1,22 @@ +--- +name: Codespell + +on: + push: + branches: [main] + pull_request: + branches: [main] + +permissions: + contents: read + +jobs: + codespell: + name: Check for spelling errors + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Codespell + uses: codespell-project/actions-codespell@v2 diff --git a/README.md b/README.md index a5a7d0fc3..1be1b9fd3 100644 --- a/README.md +++ b/README.md @@ -105,7 +105,7 @@ niCHART --data_file istaging.pkl.gz ``` ## Build executable package for Windows 10/11 -We use (beeware/briefcase)[https://github.com/beeware/briefcase)] to package +We use [beeware/briefcase](https://github.com/beeware/briefcase) to package the software in Windows 10/11. ```shell diff --git a/docs/contents/development.rst b/docs/contents/development.rst index 932367cec..38903a62c 100644 --- a/docs/contents/development.rst +++ b/docs/contents/development.rst @@ -53,7 +53,7 @@ directory. python -m pip install https://github.com/CBICA/niCHART -Once installed, the GUI is accesible as command `niCHART`. +Once installed, the GUI is accessible as command `niCHART`. .. code-block:: shell @@ -65,7 +65,7 @@ Once installed, the GUI is accesible as command `niCHART`. Build documentation locally *************************** -When ``sphinx-autobuild`` is installed, the documentation can bu built locally +When ``sphinx-autobuild`` is installed, the documentation can be built locally and automatically updates when one of the source files changes. .. code-block:: shell diff --git a/docs/contents/userguide.rst b/docs/contents/userguide.rst index 34acb88ca..2c5158433 100644 --- a/docs/contents/userguide.rst +++ b/docs/contents/userguide.rst @@ -59,7 +59,7 @@ directory. python -m pip install https://github.com/CBICA/niCHART -Once installed, the GUI is accesible as command `niCHART`. +Once installed, the GUI is accessible as command `niCHART`. .. code-block:: shell @@ -147,7 +147,7 @@ the ``SPARE-*`` plug in. SPARE-* ======= -This plugin is used to load a SPARE-* model, apply it ot the data set, and +This plugin is used to load a SPARE-* model, apply it to the data set, and optionally add the derived scores to the data set. Currently only ``SPARE-AD`` and ``SPARE-BA`` are supported. After loading the model, the plugin will verify that the loaded model is @@ -156,7 +156,7 @@ To be applied to the data, harmonized features need to be present in the data frame. After running the plugin ``Harmonization``, the necessary standardized features are available. -The computation of the scores runs asyncronously, which means that the rest of +The computation of the scores runs asynchronously, which means that the rest of the user interface remains operational. .. figure:: images/ScreenshotSPARE.png diff --git a/niCHART/core/baseplugin.py b/niCHART/core/baseplugin.py index 5305fddf4..a29870f47 100644 --- a/niCHART/core/baseplugin.py +++ b/niCHART/core/baseplugin.py @@ -21,7 +21,7 @@ def __init__(self): def activate(self): """ - On activation tell that this has been successfull. + On activation tell that this has been successful. """ # get the automatic procedure from IPlugin IPlugin.activate(self) diff --git a/pyproject.toml b/pyproject.toml index 8d42cb3eb..e57be944d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -131,3 +131,8 @@ documentation = "https://cbica.github.io/niCHART" [tool.poetry.scripts] niCHART = "niCHART:main" + +[tool.codespell] +skip = '.git,*.pdf,*.svg,MUSE*.csv' +# +ignore-words-list = 'te'