From 9fd255e2c641bf4f8d6a0f538c2ed79139c696af Mon Sep 17 00:00:00 2001
From: Yaroslav Halchenko <debian@onerussian.com>
Date: Fri, 5 Jan 2024 13:41:53 -0500
Subject: [PATCH] add codespell workflow, config and get it to fix some found
 typos (#39)

---
 .codespellrc                               |  5 +++++
 .github/workflows/codespell.yml            | 22 ++++++++++++++++++++++
 docs/tutorials/BEADL.xsd                   |  2 +-
 docs/tutorials/babl_example_notebook.ipynb |  2 +-
 src/pynwb/ndx_beadl/plot.py                |  6 +++---
 src/pynwb/tests/BEADL.xsd                  |  2 +-
 6 files changed, 33 insertions(+), 6 deletions(-)
 create mode 100644 .codespellrc
 create mode 100644 .github/workflows/codespell.yml

diff --git a/.codespellrc b/.codespellrc
new file mode 100644
index 0000000..51aed8b
--- /dev/null
+++ b/.codespellrc
@@ -0,0 +1,5 @@
+[codespell]
+skip = .git,*.pdf,*.svg,*.css,.codespellrc
+check-hidden = true
+ignore-regex = ^\s*"image/\S+": ".*
+# ignore-words-list =
diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml
new file mode 100644
index 0000000..3ebbf55
--- /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/docs/tutorials/BEADL.xsd b/docs/tutorials/BEADL.xsd
index 163da8c..578cf0a 100644
--- a/docs/tutorials/BEADL.xsd
+++ b/docs/tutorials/BEADL.xsd
@@ -296,6 +296,6 @@
     </xs:complexType>
 
     <xs:complexType name="BeadlEditorType">
-        <!-- Not implemented yet, should just have a placeholde for an SVG!?! -->
+        <!-- Not implemented yet, should just have a placeholder for an SVG!?! -->
     </xs:complexType>
 </xs:schema>
\ No newline at end of file
diff --git a/docs/tutorials/babl_example_notebook.ipynb b/docs/tutorials/babl_example_notebook.ipynb
index bf062b1..df3d6e5 100644
--- a/docs/tutorials/babl_example_notebook.ipynb
+++ b/docs/tutorials/babl_example_notebook.ipynb
@@ -1549,7 +1549,7 @@
     "# Get the StatesTable from file\n",
     "states = read_nwbfile.get_acquisition(\"task_recording\").states\n",
     "\n",
-    "# Compute the transition count and probablity matrix\n",
+    "# Compute the transition count and probability matrix\n",
     "state_transition_count_df, state_transition_probability_df = compute_state_transition_matrix(states=states, state_types=state_types)"
    ]
   },
diff --git a/src/pynwb/ndx_beadl/plot.py b/src/pynwb/ndx_beadl/plot.py
index bd8521b..065a389 100644
--- a/src/pynwb/ndx_beadl/plot.py
+++ b/src/pynwb/ndx_beadl/plot.py
@@ -61,7 +61,7 @@ def plot_events(events: Union[EventsTable, pd.DataFrame],
     :param y_offset: Offset in the y axis to use. This is used to shift the plot when combining multiple
                      plots, e.g., an events and actions plot, in the same figure.
     :param keep_yticks: When combining with other plots (e.g,. events, actions, or states), we may want to
-                     keep the text and location of existing ytick lables. (Default=False)
+                     keep the text and location of existing ytick labels. (Default=False)
     :param fig: Matplotlib figure. If None then create a new figure, otherwise assume that a figure exists.
                 (Default=None, i.e., create a new figure)
 
@@ -119,7 +119,7 @@ def plot_actions(actions: Union[ActionsTable, pd.DataFrame],
     :param y_offset: Offset in the y axis to use. This is used to shift the plot when combining multiple
                      plots, e.g., an events and actions plot, in the same figure.
     :param keep_yticks: When combining with other plots (e.g,. events, actions, or states), we may want to
-                     keep the text and location of existing ytick lables. (Default=False)
+                     keep the text and location of existing ytick labels. (Default=False)
     :param fig: Matplotlib figure. If None then create a new figure, otherwise assume that a figure exists.
                 (Default=None, i.e., create a new figure)
 
@@ -189,7 +189,7 @@ def plot_states(states: Union[StatesTable, pd.DataFrame],
     :param y_offset: Offset in the y axis to use. This is used to shift the plot when combining multiple
                      plots, e.g., an events and actions plot, in the same figure.
     :param keep_yticks: When combining with other plots (e.g,. events, actions, or states), we may want to
-                     keep the text and location of existing ytick lables. (Default=False)
+                     keep the text and location of existing ytick labels. (Default=False)
     :param fig: Matplotlib figure. If None then create a new figure, otherwise assume that a figure exists.
                 (Default=None, i.e., create a new figure)
 
diff --git a/src/pynwb/tests/BEADL.xsd b/src/pynwb/tests/BEADL.xsd
index 6c358e6..bdc300f 100644
--- a/src/pynwb/tests/BEADL.xsd
+++ b/src/pynwb/tests/BEADL.xsd
@@ -308,6 +308,6 @@
     </xs:complexType>
 
     <xs:complexType name="BeadlEditorType">
-        <!-- Not implemented yet, should just have a placeholde for an SVG!?! -->
+        <!-- Not implemented yet, should just have a placeholder for an SVG!?! -->
     </xs:complexType>
 </xs:schema>
\ No newline at end of file