Skip to content
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.

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

Add codespell support (config, workflow to detect/not fix) and make it fix few typos #573

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
25 changes: 25 additions & 0 deletions .github/workflows/codespell.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Codespell configuration is within pyproject.toml
---
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@v4
- name: Annotate locations with typos
uses: codespell-project/codespell-problem-matcher@v1
- name: Codespell
uses: codespell-project/actions-codespell@v2
2 changes: 1 addition & 1 deletion examples/asyncio_generators.py
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ async def wire_coro(**kwargs):


async def main(**kwargs):
print('Some informations about the input signal:')
print('Some information about the input signal:')
try:
await asyncio.wait_for(print_input_infos(), timeout=2)
except asyncio.TimeoutError:
Expand Down
7 changes: 7 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
[build-system]
requires = ["setuptools >= 61.0"]
build-backend = "setuptools.build_meta"

[tool.codespell]
# Ref: https://github.com/codespell-project/codespell#using-a-config-file
skip = '.git*,*.svg'
check-hidden = true
ignore-regex = '\bHDA\b'
# ignore-words-list = ''
2 changes: 1 addition & 1 deletion sounddevice.py
Original file line number Diff line number Diff line change
Expand Up @@ -2486,7 +2486,7 @@ def __init__(self, exclusive=False, auto_convert=False):


class _CallbackContext:
"""Helper class for re-use in play()/rec()/playrec() callbacks."""
"""Helper class for reuse in play()/rec()/playrec() callbacks."""

blocksize = None
data = None
Expand Down