Skip to content

codespell: config, workflow, typos fixed #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
yarikoptic wants to merge 4 commits into
base: main
Choose a base branch
from
Open

codespell: config, workflow, typos fixed #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
deea2bc
Add github action to codespell main on push and PRs
yarikoptic Mar 3, 2023
091c752
Add rudimentary .codespellrc
yarikoptic Mar 3, 2023
5869eb6
oh that te -- too popular
yarikoptic Mar 3, 2023
a5e82fc
[DATALAD RUNCMD] Run codespell throughout
yarikoptic Mar 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .codespellrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[codespell]
skip = .git,*.pdf,*.svg,versioneer.py
ignore-words-list = te
19 changes: 19 additions & 0 deletions .github/workflows/codespell.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
4 changes: 2 additions & 2 deletions MRdataset/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
----------
Expand Down Expand Up @@ -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
----------
Expand Down
2 changes: 1 addition & 1 deletion MRdataset/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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')

Expand Down
4 changes: 2 additions & 2 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.



Expand Down