diff --git a/.codespellrc b/.codespellrc new file mode 100644 index 000000000..4b169e01c --- /dev/null +++ b/.codespellrc @@ -0,0 +1,6 @@ +[codespell] +skip = .git,*.pdf,*.svg,.codespellrc +check-hidden = true +ignore-regex = ^\s*"image/\S+": ".*|^ "# .*\bbu.210506 +# importAT - is a function +ignore-words-list = importat diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml new file mode 100644 index 000000000..b281266bb --- /dev/null +++ b/.github/workflows/codespell.yml @@ -0,0 +1,22 @@ +--- +name: Codespell + +on: + push: + branches: [develop] + pull_request: + branches: [develop] + +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 diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 7d5656476..3440a67e5 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -53,7 +53,7 @@ Github has made it easy to separate issues from discussions. Generally speaking, * Optionally assign a reviewer on the right of the screen - otherwise a member of the SLEAP developer team will self-assign themselves. 8) If the reviewer requests changes, repeat steps 3-5 and `Re-request review`. 9) Once the reviewer signs off they will squash + merge the PR into the `develop` branch. - * New feautures will be available on the `main` branch when a new release of SLEAP is released. + * New features will be available on the `main` branch when a new release of SLEAP is released. ## Style Guides diff --git a/docs/guides/cli.md b/docs/guides/cli.md index 9e07c0a25..d3a4d5d07 100644 --- a/docs/guides/cli.md +++ b/docs/guides/cli.md @@ -100,7 +100,7 @@ optional arguments: Path to output directory where the frozen model will be exported to. Defaults to a folder named 'exported_model'. -r, --ragged RAGGED - Keep tensors ragged if present. If ommited, convert + Keep tensors ragged if present. If omitted, convert ragged tensors into regular tensors with NaN padding. -n, --max_instances MAX_INSTANCES Limit maximum number of instances in multi-instance models. @@ -303,7 +303,7 @@ optional arguments: naming convention .