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 action #205

Merged
merged 2 commits into from
Aug 23, 2024
Merged
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
15 changes: 15 additions & 0 deletions .codespell-ignore-words
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
blocs
bloc
inout
als
truns
pres
dum
fom
fromm
thi
nd
ue
bion
aas
checkin
5 changes: 5 additions & 0 deletions .codespellrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[codespell]
skip = .git,*.ipynb,*.bib,*.ps,*.js,*.pdf
ignore-words = .codespell-ignore-words


33 changes: 33 additions & 0 deletions .github/workflows/codespell.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: codespell

on:
push:
branches:
- development
- main
pull_request:
branches:
- development

jobs:
codespell:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: '3.10'
cache: "pip"

- name: Install dependencies
run: pip install -r ./requirements.txt

- name: Run codespell
run: |
codespell

2 changes: 1 addition & 1 deletion pyro/swe/unsplit_fluxes.py
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ def unsplit_fluxes(my_data, rp, ivars, solid, tc, dt):

"""
finally, we can construct the state perpendicular to the interface
by adding the central difference part to the trasverse flux
by adding the central difference part to the transverse flux
difference.

The states that we represent by indices i,j are shown below
Expand Down
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@ sphinx-copybutton
sphinx-prompt
importlib-metadata
prettytable
codespell