From deea2bcbb2e311b110f7734b7c697b9ccd40661a Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Fri, 3 Mar 2023 15:13:51 -0500 Subject: [PATCH 1/4] Add github action to codespell main on push and PRs --- .github/workflows/codespell.yml | 19 +++++++++++++++++++ 1 file changed, 19 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..243ba8c --- /dev/null +++ b/.github/workflows/codespell.yml @@ -0,0 +1,19 @@ +--- +name: Codespell + +on: + push: + branches: [main] + pull_request: + branches: [main] + +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 From 091c7522d7884d6edd88444459e5186faa7279c7 Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Fri, 3 Mar 2023 15:13:51 -0500 Subject: [PATCH 2/4] Add rudimentary .codespellrc --- .codespellrc | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 .codespellrc diff --git a/.codespellrc b/.codespellrc new file mode 100644 index 0000000..bb1b587 --- /dev/null +++ b/.codespellrc @@ -0,0 +1,3 @@ +[codespell] +skip = .git,*.pdf,*.svg,versioneer.py +# ignore-words-list = From 5869eb6d08e6fd68f0d147186201246295aa9a86 Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Fri, 3 Mar 2023 15:14:05 -0500 Subject: [PATCH 3/4] oh that te -- too popular --- .codespellrc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.codespellrc b/.codespellrc index bb1b587..2464a8f 100644 --- a/.codespellrc +++ b/.codespellrc @@ -1,3 +1,3 @@ [codespell] skip = .git,*.pdf,*.svg,versioneer.py -# ignore-words-list = +ignore-words-list = te From a5e82fcb0c9459d7683c9fb828206f0c28748490 Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Fri, 3 Mar 2023 15:14:19 -0500 Subject: [PATCH 4/4] [DATALAD RUNCMD] Run codespell throughout === Do not change lines below === { "chain": [], "cmd": "codespell -w", "exit": 0, "extra_inputs": [], "inputs": [], "outputs": [], "pwd": "." } ^^^ Do not change lines above ^^^ --- MRdataset/base.py | 4 ++-- MRdataset/utils.py | 2 +- README.rst | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/MRdataset/base.py b/MRdataset/base.py index af9a994..0790cae 100644 --- a/MRdataset/base.py +++ b/MRdataset/base.py @@ -291,7 +291,7 @@ class Project(Node): Container to manage properties and issues at the project level. Encapsulates all the details necessary for a complete project. A single project may contain multiple modalities, and each modality - will have atleast single subject. + will have at least single subject. Attributes ---------- @@ -449,7 +449,7 @@ class Modality(Node): Container to manage properties and issues at the modality level. Encapsulates all the details necessary for a modality. A single modality may contain multiple subjects, and each subject - will have atleast single session. + will have at least single session. Attributes ---------- diff --git a/MRdataset/utils.py b/MRdataset/utils.py index 6305136..03ac05b 100644 --- a/MRdataset/utils.py +++ b/MRdataset/utils.py @@ -35,7 +35,7 @@ def safe_get(dictionary: dict, keys: str, default=None): @return: object Examples: - To get value, dictonary[tag1][tag2][tag3], + To get value, dictionary[tag1][tag2][tag3], if KeyError: return default >>> items = safe_get(dictionary, 'tags1.tag2.tag3') diff --git a/README.rst b/README.rst index b69b76d..be4206e 100644 --- a/README.rst +++ b/README.rst @@ -44,12 +44,12 @@ a Generic My NeuroImaging Dataset, inherit ``MRdataset.base.Project`` in a file def walk(): - # implement the heirarchy and ways to traverse the dataset + # implement the hierarchy and ways to traverse the dataset # add your logic to parse and handle edge cases etc -Thats it! You would be able parse and zip through your dataset easily e.g., when interfacing with `mrQA` or similar. +That's it! You would be able parse and zip through your dataset easily e.g., when interfacing with `mrQA` or similar.