Skip to content

Commit aa736ed

Browse files
authored
run codespell on notebooks (#347)
this will preprocess the notebooks and remove the output first
1 parent 8d6fb88 commit aa736ed

File tree

4 files changed

+6
-3
lines changed

4 files changed

+6
-3
lines changed

.codespellrc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[codespell]
2-
skip = .git,*.ipynb,*.bib,*.ps,*.js,*.pdf
2+
skip = .git,*.bib,*.ps,*.js,*.pdf
33
ignore-words = .codespell-ignore-words
44

55

.github/workflows/codespell.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ jobs:
2626
- name: Install dependencies
2727
run: pip install -r ./requirements.txt
2828

29+
- name: Preprocess notebooks
30+
run: for i in $(find . -name "*.ipynb"); do jupyter nbconvert --clear-output --inplace $i; done
31+
2932
- name: Run codespell
3033
run: |
3134
codespell

docs/source/adding_a_problem_jupyter.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@
114114
"id": "6f682998-c452-4fdf-87dc-bac340e9e9df",
115115
"metadata": {},
116116
"source": [
117-
"It often works best if you start with an existing problem. We can inspect the source of one of the build-in problems easily:"
117+
"It often works best if you start with an existing problem. We can inspect the source of one of the built-in problems easily:"
118118
]
119119
},
120120
{

docs/source/rt_average.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
"id": "6395d3eb-9572-454b-823a-b5c2f8c4267d",
1414
"metadata": {},
1515
"source": [
16-
"Here we show how to do a lateral / horizonal average of the compressible Rayleigh-Taylor\n",
16+
"Here we show how to do a lateral / horizontal average of the compressible Rayleigh-Taylor\n",
1717
"simulation to see what the average vertical profile of the mixing looks like."
1818
]
1919
},

0 commit comments

Comments
 (0)