From 9c80087b08906075142b9fe84da29f297380cb45 Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Wed, 20 Sep 2023 11:31:28 -0400 Subject: [PATCH 01/10] Add github action to codespell master on push and PRs --- .github/workflows/codespell.yml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .github/workflows/codespell.yml diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml new file mode 100644 index 0000000..7373aff --- /dev/null +++ b/.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 From 93497329c6e17fa7d10a5811bde5df4e3df442e1 Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Wed, 20 Sep 2023 11:31:28 -0400 Subject: [PATCH 02/10] Add rudimentary codespell config --- .codespellrc | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 .codespellrc diff --git a/.codespellrc b/.codespellrc new file mode 100644 index 0000000..da3c057 --- /dev/null +++ b/.codespellrc @@ -0,0 +1,4 @@ +[codespell] +skip = .git,*.pdf,*.svg +# +# ignore-words-list = From cfad6c78b16c87fd0466e78bcd6449c218f89ba6 Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Wed, 20 Sep 2023 11:32:03 -0400 Subject: [PATCH 03/10] ignores --- .codespellrc | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.codespellrc b/.codespellrc index da3c057..bcf03fc 100644 --- a/.codespellrc +++ b/.codespellrc @@ -1,4 +1,3 @@ [codespell] -skip = .git,*.pdf,*.svg -# -# ignore-words-list = +skip = .git,*.pdf,*.svg,deprecated +ignore-words-list = covert From 246ca80939f6e811bfabe30008882d059f629df1 Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Wed, 20 Sep 2023 11:32:31 -0400 Subject: [PATCH 04/10] [DATALAD RUNCMD] fix ambigous typos manually === Do not change lines below === { "chain": [], "cmd": "codespell -i3 -C4 -w ./docs/source/05_Advanced_annotation.md", "exit": 0, "extra_inputs": [], "inputs": [], "outputs": [], "pwd": "." } ^^^ Do not change lines above ^^^ --- docs/source/05_Advanced_annotation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/05_Advanced_annotation.md b/docs/source/05_Advanced_annotation.md index f255884..7132bcc 100644 --- a/docs/source/05_Advanced_annotation.md +++ b/docs/source/05_Advanced_annotation.md @@ -306,7 +306,7 @@ playing of different clips. > *Data-property/Data-marker/Temporal-marker/Onset,* > *(Property/Informational-property/Label/StarWars,* > *(Item/Object/Man-made-object/Media/Media-clip,* -> *Properity/Informational-property/ID/3284)))* +> *Property/Informational-property/ID/3284)))* > .... [The Star Wars movie clip is playing] .... From 76bd2b1b1198d9e717f6e425db1b39a36de8a5fa Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Thu, 18 Apr 2024 22:39:03 -0400 Subject: [PATCH 05/10] [DATALAD RUNCMD] Do interactive fixing of leftover ambigous typos === Do not change lines below === { "chain": [], "cmd": "codespell -w -i 3 -C 2 ./docs/source/02_Terminology.md", "exit": 0, "extra_inputs": [], "inputs": [], "outputs": [], "pwd": "." } ^^^ Do not change lines above ^^^ --- docs/source/02_Terminology.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/02_Terminology.md b/docs/source/02_Terminology.md index 11cd801..435da88 100644 --- a/docs/source/02_Terminology.md +++ b/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) | From 0efb9b896d71b35e95b4e59cf2334630edb757a2 Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Fri, 19 Apr 2024 10:38:12 -0400 Subject: [PATCH 06/10] Run on both master and develop branches (and PRs to them) --- .github/workflows/codespell.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml index 7373aff..cce8ccd 100644 --- a/.github/workflows/codespell.yml +++ b/.github/workflows/codespell.yml @@ -3,9 +3,9 @@ name: Codespell on: push: - branches: [master] + branches: [master,develop] pull_request: - branches: [master] + branches: [master,develop] permissions: contents: read From 5424f11ac8f25d7a405f276dd881f3b64c3ae350 Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Fri, 19 Apr 2024 10:40:28 -0400 Subject: [PATCH 07/10] ignore hed --- .codespellrc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.codespellrc b/.codespellrc index bcf03fc..788c7c1 100644 --- a/.codespellrc +++ b/.codespellrc @@ -1,3 +1,3 @@ [codespell] skip = .git,*.pdf,*.svg,deprecated -ignore-words-list = covert +ignore-words-list = covert,hed From c1af738b667b50d2c65237cd2f62a91fc07ea460 Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Fri, 19 Apr 2024 10:43:38 -0400 Subject: [PATCH 08/10] ignore produced *.xml, *.mediawiki, *.omn files per authors recommendation --- .codespellrc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.codespellrc b/.codespellrc index 788c7c1..67493a7 100644 --- a/.codespellrc +++ b/.codespellrc @@ -1,3 +1,3 @@ [codespell] -skip = .git,*.pdf,*.svg,deprecated +skip = .git,*.pdf,*.svg,deprecated,*.xml,*.mediawiki,*.omn ignore-words-list = covert,hed From 689d0e3c68fe2e49e59eb6e1a12e98cb9f1553ab Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Fri, 19 Apr 2024 10:44:01 -0400 Subject: [PATCH 09/10] [DATALAD RUNCMD] run codespell throughout fixing typos automagically === Do not change lines below === { "chain": [], "cmd": "codespell -w", "exit": 0, "extra_inputs": [], "inputs": [], "outputs": [], "pwd": "." } ^^^ Do not change lines above ^^^ --- docs/source/03_HED_formats.md | 2 +- docs/source/07_Library_schemas.md | 4 ++-- docs/source/08_HED_ontology.md | 2 +- docs/source/Appendix_A.md | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/source/03_HED_formats.md b/docs/source/03_HED_formats.md index f061508..c97f1a6 100644 --- a/docs/source/03_HED_formats.md +++ b/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. diff --git a/docs/source/07_Library_schemas.md b/docs/source/07_Library_schemas.md index d187bfc..0a3fd0d 100644 --- a/docs/source/07_Library_schemas.md +++ b/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 (hed.maintainers@gmail.com) 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**:
-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.
 
2. **Use semantic versioning**:
diff --git a/docs/source/08_HED_ontology.md b/docs/source/08_HED_ontology.md index 3550415..349d0d0 100644 --- a/docs/source/08_HED_ontology.md +++ b/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. diff --git a/docs/source/Appendix_A.md b/docs/source/Appendix_A.md index a83c690..929ba25 100644 --- a/docs/source/Appendix_A.md +++ b/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
unit modifer
value class + - unit
unit modifier
value class - string - Specifies a character used in values of this class. * - [`conversionFactor`](#a142-conversionfactor) From f0040209724d33d33d87fee4135602ee8eab1100 Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Fri, 19 Apr 2024 14:46:42 -0400 Subject: [PATCH 10/10] boost checkout version --- .github/workflows/codespell.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml index cce8ccd..2775f5e 100644 --- a/.github/workflows/codespell.yml +++ b/.github/workflows/codespell.yml @@ -17,6 +17,6 @@ jobs: steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Codespell uses: codespell-project/actions-codespell@v2