Skip to content

Commit 1ddcd01

Browse files
authored
Merge pull request #1354 from yarikoptic/enh-codespell
Add codespell support (config, workflow to detect/not fix) and make it fix some typos
2 parents 3c5affd + bb230ca commit 1ddcd01

26 files changed

Lines changed: 150 additions & 118 deletions

.github/workflows/codespell.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Codespell configuration is within setup.cfg
2+
---
3+
name: Codespell
4+
5+
on:
6+
push:
7+
branches: [master]
8+
pull_request:
9+
branches: [master]
10+
11+
permissions:
12+
contents: read
13+
14+
jobs:
15+
codespell:
16+
name: Check for spelling errors
17+
runs-on: ubuntu-latest
18+
19+
steps:
20+
- name: Checkout
21+
uses: actions/checkout@v4
22+
- name: Annotate locations with typos
23+
uses: codespell-project/codespell-problem-matcher@v1
24+
- name: Codespell
25+
uses: codespell-project/actions-codespell@v2

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Phy provides two GUIs:
3232

3333
## Hardware requirements
3434

35-
It is recommanded to store the data on a SSD for performance reasons.
35+
It is recommended to store the data on a SSD for performance reasons.
3636

3737
There are no specific GPU requirements as long as relatively recent graphics and OpenGL drivers are installed on the system.
3838

0 commit comments

Comments
 (0)