Merge pull request #165 from yarikoptic/enh-codespell

Codespell: workflow, condig + some typos fixed

Author: ZviBaratz

.codespellrc

@@ -0,0 +1,3 @@
+[codespell]
+skip = .git,*.pdf,*.svg
+# ignore-words-list = 

.github/workflows/codespell.yml

@@ -0,0 +1,19 @@
+---
+name: Codespell
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+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@v1

docs/source/faq.rst

@@ -22,7 +22,7 @@ Is The Labbing Project only suitable for MRI-based neuroscientific research?
 
 Not at all! The purpose of the :mod:`research` app is to provide common,
 generic models (such as :class:`~research.models.subject.Subject` and
-:class:`~research.models.study.Study`) that may be associted with any number of
+:class:`~research.models.study.Study`) that may be associated with any number of
 data models originating from any number of reusable apps.
 
 How are different data types integrated into the application's database?

external_tables/models/sync_table.py

@@ -59,7 +59,7 @@ def sync(self) -> None:
     @property
     def df(self) -> pd.DataFrame:
         """
-        Returs the :class:`SyncTable` as a dataframe.
+        Returns the :class:`SyncTable` as a dataframe.
 
         Returns
         -------

plots/series/series_viewer/utils/figures_manager.py

@@ -71,7 +71,7 @@ def create_image_model(self, plane: Plane) -> Image:
         Returns
         -------
         Image
-            The created Image instace for the given plot.
+            The created Image instance for the given plot.
         """
 
         plot = self.figures[plane].image(

plots/series/series_viewer/utils/widgets_manager.py

@@ -144,7 +144,7 @@ def toggle_index_sliders_visibility(self, active: bool):
         Parameters
         ----------
         active : bool
-            Index sliders' visiblity toggle button state.
+            Index sliders' visibility toggle button state.
         """
 
         for slider in self.index_sliders.values():
@@ -171,7 +171,7 @@ def toggle_range_sliders_visibility(self, active: bool):
         Parameters
         ----------
         active : bool
-            Range sliders' visiblity toggle button state.
+            Range sliders' visibility toggle button state.
         """
 
         for slider in self.range_sliders.values():
@@ -211,7 +211,7 @@ def create_palette_select(self) -> Select:
 
     def create_visibility_checkbox(self) -> CheckboxButtonGroup:
         """
-        Toggles crosshair and axes visiblity on or off.
+        Toggles crosshair and axes visibility on or off.
 
         Returns
         -------

pylabber/settings.py

@@ -151,7 +151,7 @@
 LOGIN_REDIRECT_URL = "/"
 LOGOUT_REDIRECT_URL = "/"
 
-# Password strengh validation
+# Password strength validation
 VALIDATION_MODULE = "django.contrib.auth.password_validation"
 SIMILARITY_VALIDATOR = f"{VALIDATION_MODULE}.UserAttributeSimilarityValidator"
 MINIMUM_LENGTH_VALIDATOR = f"{VALIDATION_MODULE}.MinimumLengthValidator"

pylabber/views/pagination.py

@@ -7,7 +7,7 @@ class StandardResultsSetPagination(PageNumberPagination):
     when implemented as part of the defaults mixin and therefore was moved
     to this class, which is meant to be set in the
     `ViewSets <https://www.django-rest-framework.org/api-guide/viewsets/>`_'
-    *pagination_class* attribue definition, or in the REST_FRAMEWORK definition
+    *pagination_class* attribute definition, or in the REST_FRAMEWORK definition
     within settings.py. For much information see
     `the DRF documentation <https://www.django-rest-framework.org/api-guide/pagination/#modifying-the-pagination-style>`_.
     

research/tests/models/test_subject.py

@@ -99,7 +99,7 @@ def test_get_personal_information(self):
         # result = self.test_subject.get_personal_information()
         # result = result[[item for item in ]]
 
-        # excpected = {
+        # expected = {
         #     ("Anonymized", "Patient ID"): "ABC123",
         #     ("Anonymized", "First Name"): "Noam",
         #     ("Anonymized", "Last Name"): "Aharony",

research/views/study.py

@@ -1,5 +1,5 @@
 """
-Definintion of the :class:`StudyViewSet` class.
+Definition of the :class:`StudyViewSet` class.
 """
 from typing import Tuple