Merge pull request #589 from yarikoptic/enh-codespell

Attempt #2: Add codespell support (config, workflow to detect/not fix) and make it fix few typos

.codespellrc

@@ -0,0 +1,3 @@
+[codespell]
+skip = .git,*.pdf,*.svg,deprecated,*.xml,*.mediawiki,*.omn
+ignore-words-list = covert,hed

.github/workflows/codespell.yml

@@ -0,0 +1,22 @@
+---
+name: Codespell
+
+on:
+  push:
+    branches: [master,develop]
+  pull_request:
+    branches: [master,develop]
+
+permissions:
+  contents: read
+
+jobs:
+  codespell:
+    name: Check for spelling errors
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Codespell
+        uses: codespell-project/actions-codespell@v2

docs/source/02_Terminology.md

@@ -150,7 +150,7 @@ The types of characters referred to in this specification are:
 | `lowercase` | ASCII characters a-z |  
 | `uppercase` | ASCII characters A-Z |
 | `letters` | `lowercase` and/or `uppercase` |
-| `text` | `printable` and/or `nonascii` exluding comma, square brackets, and curly braces.|
+| `text` | `printable` and/or `nonascii` excluding comma, square brackets, and curly braces.|
 | `digits` | 0-9 |
 | `tab` | ASCII code 09 |
 | `newline` | ASCII code 10 (linefeed) |

docs/source/03_HED_formats.md

@@ -1215,7 +1215,7 @@ and whose names do not appear in the curly braces of other HED annotations.
 3. For each the column in the assembly list look up the annotation in the sidecar, replacing all curly braces and place holder values appropriately.
 Append to the result list.
 4. If a `HED` column annotation exists for that row and `HED` did not appear
-in curly braces in the sidecar, concatentate the annotation to the result list.
+in curly braces in the sidecar, concatenate the annotation to the result list.
 5. Finally, join all the entries of the result list using a comma (`,`) separator.
 
 In all cases `n/a` column values are skipped.

docs/source/05_Advanced_annotation.md

@@ -306,7 +306,7 @@ playing of different clips.
 > *Data-property/Data-marker/Temporal-marker/<strong>Onset</strong>,*  
 > *(Property/Informational-property/<strong>Label/StarWars</strong>,*  
 > *(Item/Object/Man-made-object/Media/<strong>Media-clip</strong>,*  
-> *Properity/Informational-property/<strong>ID/3284</strong>)))*  
+> *Property/Informational-property/<strong>ID/3284</strong>)))*  
             
 >         .... [The Star Wars movie clip is playing] ....
 

docs/source/07_Library_schemas.md

@@ -311,7 +311,7 @@ error is generated.
 **Note:** With the possible (and rare) exception of new `unitClasses` and `units`, partnered library schemas 
 should not have auxiliary sections except for the `prologue` and `epilogue`.  
 
-Auxilliary sections have information for HED tools, and new entries may require modification to
+Auxiliary sections have information for HED tools, and new entries may require modification to
 schema validation tools.  
 
 If a new entry is needed, contact the HED Working Group ([email protected]) to see if the
@@ -336,7 +336,7 @@ This section summarizes the general design rules for all library schema.
 :class: tip
 
 1. **Follow naming conventions**:<br/>
-A library schema must be given a name containing only alphabetic chararacters.
+A library schema must be given a name containing only alphabetic characters.
 This name must appear in the schema header line in the required format.
 <br>&nbsp;</br>
 2. **Use semantic versioning**:<br/>

docs/source/08_HED_ontology.md

@@ -219,7 +219,7 @@ The following table summarizes how the HED schema and HED ontology are mapped.
   - * Defined in the `Unit Modifiers` section of the HED schema.
     * Usually only defined in the standard schema
     * Defining schemas must define a class extending `HedUnitModifier` (`heds:HED_0000008`).
-    * Unit modifers in the standard schema inherit from `StandardUnitModifier` (`HED_0010008`).
+    * Unit modifiers in the standard schema inherit from `StandardUnitModifier` (`HED_0010008`).
 * - **Value class** 
   - * Defined in the `Value classes` section of the HED schema.
     * Usually only defined in the standard schema.

docs/source/Appendix_A.md

@@ -238,7 +238,7 @@ Only the schema attributes listed in the following table can be handled by curre
   - Range
   - Description  
 * - [`allowedCharacter`](#a141-allowedcharacter)  
-  - unit<br/>unit modifer<br/>value class  
+  - unit<br/>unit modifier<br/>value class  
   - string
   - Specifies a character used in values of this class.  
 * - [`conversionFactor`](#a142-conversionfactor)