Merge pull request #543 from yarikoptic/enh-codespell

add codespell: config, workflow and have typos fixed

.codespellrc

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

.github/workflows/codespell.yml

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

docs/source/03_HED_formats.md

@@ -1192,7 +1192,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

@@ -277,7 +277,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/Appendix_B.md

@@ -373,7 +373,7 @@ under an appropriate unit class).
 | Attribute | Invalid attribute value                                                            |
 | --------- |------------------------------------------------------------------------------------|
 | `allowedCharacter` | Not a single character or one of:<br>`letters`, `blank`, `digits`, `alphanumeric`. |
-| `conversionFactor` | Not a postive numeric value.                                                       |  
+| `conversionFactor` | Not a positive numeric value.                                                       |  
 | `defaultUnits` | Not a valid unit in this unit class.                                               |   
 | `deprecatedFrom` | Not a valid semantic version number not later than current schema version. |
 | `inLibrary` |  |

hedwiki/HED7.2.0.mediawiki

@@ -121,7 +121,7 @@ From version 2.2, HED adheres to http://semver.org/ versioning.
 *** <nowiki># {takesValue}</nowiki> 
 * Group ID <nowiki>{requireChild, predicateType=propertyOf} [Optional]</nowiki> 
 ** <nowiki># {takesValue}</nowiki> 
-* Object <nowiki> [Visually discernable objects. This item excludes sounds that are Items but not objects]</nowiki> 
+* Object <nowiki> [Visually discernible objects. This item excludes sounds that are Items but not objects]</nowiki> 
 ** Vehicle 
 *** Bicycle 
 *** Car 
@@ -1161,7 +1161,7 @@ From version 2.2, HED adheres to http://semver.org/ versioning.
 * Psychomotor vigilance task
 * Pursuit rotor task 
 * Pyramids and palm trees task 
-* Rapid automatized naming test 
+* Rapid automated naming test 
 * Rapid serial object transformation 
 * Reading - Covert
 * Reading - Overt

hedwiki/HED7.3.0.mediawiki

@@ -121,7 +121,7 @@ From version 2.2, HED adheres to http://semver.org/ versioning.
 *** <nowiki># {takesValue}</nowiki> 
 * Group ID <nowiki>{requireChild, predicateType=propertyOf} [Optional]</nowiki> 
 ** <nowiki># {takesValue}</nowiki> 
-* Object <nowiki> [Visually discernable objects. This item excludes sounds that are Items but not objects]</nowiki> 
+* Object <nowiki> [Visually discernible objects. This item excludes sounds that are Items but not objects]</nowiki> 
 ** Vehicle 
 *** Bicycle 
 *** Car 
@@ -1161,7 +1161,7 @@ From version 2.2, HED adheres to http://semver.org/ versioning.
 * Psychomotor vigilance task
 * Pursuit rotor task 
 * Pyramids and palm trees task 
-* Rapid automatized naming test 
+* Rapid automated naming test 
 * Rapid serial object transformation 
 * Reading - Covert
 * Reading - Overt

hedwiki/HED8.0.0.mediawiki

@@ -170,7 +170,7 @@ This schema is the first official release that includes an xsd and requires unit
 ** Learn <nowiki>[Adaptively change behavior as the result of experience.]</nowiki>
 ** Memorize <nowiki>[Adaptively change behavior as the result of experience.]</nowiki>
 ** Plan <nowiki>[Think about the activities required to achieve a desired goal. ]</nowiki>
-** Predict <nowiki>[Say or estimate that something will happen or will be a consequence of something without having exact informaton.]</nowiki>
+** Predict <nowiki>[Say or estimate that something will happen or will be a consequence of something without having exact information.]</nowiki>
 ** Recognize <nowiki>[Identify someone or something from having encountered them before.]</nowiki>
 ** Respond <nowiki>[React to something such as a treatment or a stimulus.]</nowiki>
 ** Recall <nowiki>[Remember information by mental effort.]</nowiki>
@@ -324,7 +324,7 @@ This schema is the first official release that includes an xsd and requires unit
 ***** Clock <nowiki>[A device designed to indicate the time of day or to measure the time duration of an event or action.]</nowiki>
 ****** Clock-face <nowiki>[A location identifier based on clockface numbering or anatomic subregion.]</nowiki>
 **** Robot <nowiki>[A mechanical device that sometimes resembles a living animal and is capable of performing a variety of often complex human tasks on command or by being programmed in advance.]</nowiki>
-**** Tool <nowiki>[A component that is not part of a device but is designed to support its assemby or operation.]</nowiki>
+**** Tool <nowiki>[A component that is not part of a device but is designed to support its assembly or operation.]</nowiki>
 ***	Document <nowiki>[A physical object, or electronic counterpart, that is characterized by containing writing which is meant to be human-readable.]</nowiki>
 **** Letter <nowiki>[A written message addressed to a person or organization.]</nowiki>
 **** Note <nowiki>[A brief written record.]</nowiki>
@@ -370,7 +370,7 @@ This schema is the first official release that includes an xsd and requires unit
 **** Cart <nowiki>[A cart is a vehicle which has two wheels and is designed to transport human passengers or cargo.]</nowiki>
 **** Tractor <nowiki>[A mobile machine specifically designed to deliver a high tractive effort at slow speeds, and mainly used for the purposes of hauling a trailer or machinery used in agriculture or construction.]</nowiki>
 **** Train <nowiki>[A connected line of railroad cars with or without a locomotive.]</nowiki>
-**** Truck <nowiki>[A motor vehicle which, as its primary funcion, transports cargo rather than human passangers.]</nowiki>
+**** Truck <nowiki>[A motor vehicle which, as its primary function, transports cargo rather than human passangers.]</nowiki>
 ** Natural-object <nowiki>[Something that exists in or is produced by nature, and is not artificial or man-made.]</nowiki>
 *** Mineral <nowiki>[A solid, homogeneous, inorganic substance occurring in nature and having a definite chemical composition.]</nowiki>
 *** Natural-feature <nowiki>[A feature that occurs in nature. A prominent or identifiable aspect, region, or site of interest.]</nowiki>
@@ -380,7 +380,7 @@ This schema is the first official release that includes an xsd and requires unit
 **** River <nowiki>[A natural freshwater surface stream of considerable volume and a permanent or seasonal flow, moving in a definite channel toward a sea, lake, or another river.]</nowiki>
 **** Waterfall <nowiki>[A sudden descent of water over a step or ledge in the bed of a river.]</nowiki>
 * Sound <nowiki>[Mechanical vibrations transmitted by an elastic medium. Something that can be heard.]</nowiki>
-** Environmental-sound<nowiki>[Sounds occuring in the environment. An accumulation of noise pollution that occurs outside. This noise can be caused by transport, industrial, and recreational activities.]</nowiki>
+** Environmental-sound<nowiki>[Sounds occurring in the environment. An accumulation of noise pollution that occurs outside. This noise can be caused by transport, industrial, and recreational activities.]</nowiki>
 *** Crowd-sound <nowiki>[Noise produced by a mixture of sounds from a large group of people.]</nowiki>
 *** Signal-noise <nowiki>[Any part of a signal that is not the true or original signal but is introduced by the communication mechanism.]</nowiki>
 ** Musical-sound <nowiki>[Sound produced by continuous and regular vibrations, as opposed to noise.]</nowiki>
@@ -581,7 +581,7 @@ This schema is the first official release that includes an xsd and requires unit
 **** Weight <nowiki>[The relative mass or the quantity of matter contained by something.]</nowiki>
 ***** <nowiki># {takesValue, valueClass=numericClass, unitClass=weightUnits}</nowiki>
 *** Quantitative-value <nowiki>[Something capable of being estimated or expressed with numeric values.] </nowiki> 
-**** Fraction <nowiki>[A numerical value betwee 0 and 1.]</nowiki>
+**** Fraction <nowiki>[A numerical value between 0 and 1.]</nowiki>
 ***** <nowiki># {takesValue, valueClass=numericClass}</nowiki>
 **** Item-count <nowiki>[The integer count of something which is usually grouped with the entity it is counting. (Item-count/3, A) indicates that 3 of A have occurred up to this point.]</nowiki>
 ***** <nowiki># {takesValue, valueClass=numericClass}</nowiki>  
@@ -608,7 +608,7 @@ This schema is the first official release that includes an xsd and requires unit
 ***** <nowiki># {takesValue, valueClass=numericClass}</nowiki> 
 **** Statistical-precision <nowiki>[A quantitative representation of the degree of accuracy necessary for or associated with a particular action.]</nowiki>
 ***** <nowiki># {takesValue, valueClass=numericClass}</nowiki> 
-**** Statistical-recall <nowiki>[Sensitivity is a measurement datum qualifying a binary classification test and is computed by substracting the false negative rate to the integral numeral 1.]</nowiki>
+**** Statistical-recall <nowiki>[Sensitivity is a measurement datum qualifying a binary classification test and is computed by subtracting the false negative rate to the integral numeral 1.]</nowiki>
 ***** <nowiki># {takesValue, valueClass=numericClass}</nowiki> 
 **** Statistical-uncertainty <nowiki> [A measure of the inherent variability of repeated observation measurements of a quantity including quantities evaluated by statistical methods and by other means.]</nowiki>
 ***** <nowiki># {takesValue, valueClass=numericClass}</nowiki>
@@ -689,7 +689,7 @@ This schema is the first official release that includes an xsd and requires unit
 ** Urban <nowiki>[Relating to, located in, or characteristic of a city or densely populated area.]</nowiki>
 ** Rural <nowiki>[Of or pertaining to the country as opposed to the city.]</nowiki>
 ** Terrain <nowiki>[Characterization of the physical features of a tract of land.]</nowiki>
-*** Composite-terrain <nowiki>[Tracts of land characterized by a mixure of physical features.]</nowiki>
+*** Composite-terrain <nowiki>[Tracts of land characterized by a mixture of physical features.]</nowiki>
 *** Dirt-terrain <nowiki>[Tracts of land characterized by a soil surface and lack of vegetation.]</nowiki>
 *** Grassy-terrain <nowiki>[Tracts of land covered by grass.]</nowiki>
 *** Gravel-terrain <nowiki>[Tracts of land covered by a surface consisting a loose aggregation of small water-worn or pounded stones.]</nowiki>

hedwiki/HED8.1.0.mediawiki

@@ -170,7 +170,7 @@ This schema includes an xsd and requires unit class, unit modifier, value class,
 ** Learn <nowiki>[Adaptively change behavior as the result of experience.]</nowiki>
 ** Memorize <nowiki>[Adaptively change behavior as the result of experience.]</nowiki>
 ** Plan <nowiki>[Think about the activities required to achieve a desired goal. ]</nowiki>
-** Predict <nowiki>[Say or estimate that something will happen or will be a consequence of something without having exact informaton.]</nowiki>
+** Predict <nowiki>[Say or estimate that something will happen or will be a consequence of something without having exact information.]</nowiki>
 ** Recognize <nowiki>[Identify someone or something from having encountered them before.]</nowiki>
 ** Respond <nowiki>[React to something such as a treatment or a stimulus.]</nowiki>
 ** Recall <nowiki>[Remember information by mental effort.]</nowiki>
@@ -326,7 +326,7 @@ This schema includes an xsd and requires unit class, unit modifier, value class,
 ***** Clock <nowiki>[A device designed to indicate the time of day or to measure the time duration of an event or action.]</nowiki>
 ****** Clock-face <nowiki>[A location identifier based on clockface numbering or anatomic subregion.]</nowiki>
 **** Robot <nowiki>[A mechanical device that sometimes resembles a living animal and is capable of performing a variety of often complex human tasks on command or by being programmed in advance.]</nowiki>
-**** Tool <nowiki>[A component that is not part of a device but is designed to support its assemby or operation.]</nowiki>
+**** Tool <nowiki>[A component that is not part of a device but is designed to support its assembly or operation.]</nowiki>
 ***	Document <nowiki>[A physical object, or electronic counterpart, that is characterized by containing writing which is meant to be human-readable.]</nowiki>
 **** Letter <nowiki>[A written message addressed to a person or organization.]</nowiki>
 **** Note <nowiki>[A brief written record.]</nowiki>
@@ -373,7 +373,7 @@ This schema includes an xsd and requires unit class, unit modifier, value class,
 **** Cart <nowiki>[A cart is a vehicle which has two wheels and is designed to transport human passengers or cargo.]</nowiki>
 **** Tractor <nowiki>[A mobile machine specifically designed to deliver a high tractive effort at slow speeds, and mainly used for the purposes of hauling a trailer or machinery used in agriculture or construction.]</nowiki>
 **** Train <nowiki>[A connected line of railroad cars with or without a locomotive.]</nowiki>
-**** Truck <nowiki>[A motor vehicle which, as its primary funcion, transports cargo rather than human passangers.]</nowiki>
+**** Truck <nowiki>[A motor vehicle which, as its primary function, transports cargo rather than human passangers.]</nowiki>
 ** Natural-object <nowiki>[Something that exists in or is produced by nature, and is not artificial or man-made.]</nowiki>
 *** Mineral <nowiki>[A solid, homogeneous, inorganic substance occurring in nature and having a definite chemical composition.]</nowiki>
 *** Natural-feature <nowiki>[A feature that occurs in nature. A prominent or identifiable aspect, region, or site of interest.]</nowiki>
@@ -383,7 +383,7 @@ This schema includes an xsd and requires unit class, unit modifier, value class,
 **** River <nowiki>[A natural freshwater surface stream of considerable volume and a permanent or seasonal flow, moving in a definite channel toward a sea, lake, or another river.]</nowiki>
 **** Waterfall <nowiki>[A sudden descent of water over a step or ledge in the bed of a river.]</nowiki>
 * Sound <nowiki>[Mechanical vibrations transmitted by an elastic medium. Something that can be heard.]</nowiki>
-** Environmental-sound<nowiki>[Sounds occuring in the environment. An accumulation of noise pollution that occurs outside. This noise can be caused by transport, industrial, and recreational activities.]</nowiki>
+** Environmental-sound<nowiki>[Sounds occurring in the environment. An accumulation of noise pollution that occurs outside. This noise can be caused by transport, industrial, and recreational activities.]</nowiki>
 *** Crowd-sound <nowiki>[Noise produced by a mixture of sounds from a large group of people.]</nowiki>
 *** Signal-noise <nowiki>[Any part of a signal that is not the true or original signal but is introduced by the communication mechanism.]</nowiki>
 ** Musical-sound <nowiki>[Sound produced by continuous and regular vibrations, as opposed to noise.]</nowiki>
@@ -619,7 +619,7 @@ This schema includes an xsd and requires unit class, unit modifier, value class,
 ***** <nowiki># {takesValue, valueClass=numericClass}</nowiki> 
 **** Statistical-precision <nowiki>[A quantitative representation of the degree of accuracy necessary for or associated with a particular action.]</nowiki>
 ***** <nowiki># {takesValue, valueClass=numericClass}</nowiki> 
-**** Statistical-recall <nowiki>[Sensitivity is a measurement datum qualifying a binary classification test and is computed by substracting the false negative rate to the integral numeral 1.]</nowiki>
+**** Statistical-recall <nowiki>[Sensitivity is a measurement datum qualifying a binary classification test and is computed by subtracting the false negative rate to the integral numeral 1.]</nowiki>
 ***** <nowiki># {takesValue, valueClass=numericClass}</nowiki> 
 **** Statistical-uncertainty <nowiki> [A measure of the inherent variability of repeated observation measurements of a quantity including quantities evaluated by statistical methods and by other means.]</nowiki>
 ***** <nowiki># {takesValue, valueClass=numericClass}</nowiki>
@@ -700,7 +700,7 @@ This schema includes an xsd and requires unit class, unit modifier, value class,
 ** Urban <nowiki>[Relating to, located in, or characteristic of a city or densely populated area.]</nowiki>
 ** Rural <nowiki>[Of or pertaining to the country as opposed to the city.]</nowiki>
 ** Terrain <nowiki>[Characterization of the physical features of a tract of land.]</nowiki>
-*** Composite-terrain <nowiki>[Tracts of land characterized by a mixure of physical features.]</nowiki>
+*** Composite-terrain <nowiki>[Tracts of land characterized by a mixture of physical features.]</nowiki>
 *** Dirt-terrain <nowiki>[Tracts of land characterized by a soil surface and lack of vegetation.]</nowiki>
 *** Grassy-terrain <nowiki>[Tracts of land covered by grass.]</nowiki>
 *** Gravel-terrain <nowiki>[Tracts of land covered by a surface consisting a loose aggregation of small water-worn or pounded stones.]</nowiki>