diff --git a/.codespellrc b/.codespellrc new file mode 100644 index 0000000..2464a8f --- /dev/null +++ b/.codespellrc @@ -0,0 +1,3 @@ +[codespell] +skip = .git,*.pdf,*.svg,versioneer.py +ignore-words-list = te 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 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.