Skip to content

Commit abd760f

Browse files
committed
spelling, take1
1 parent d604797 commit abd760f

File tree

5 files changed

+84
-1
lines changed

5 files changed

+84
-1
lines changed

.github/spellcheck-settings.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
matrix:
2+
- name: Markdown
3+
expect_match: false
4+
apsell:
5+
mode: en
6+
dictionary:
7+
wordlists:
8+
- .github/wordlist.txt
9+
output: wordlist.dic
10+
encoding: utf-8
11+
pipeline:
12+
- pyspelling.filters.markdown:
13+
markdown_extensions:
14+
- markdown.extensions.extra:
15+
- pyspelling.filters.html:
16+
comments: true
17+
attributes:
18+
- alt
19+
ignores:
20+
- ':matches(code, pre)'
21+
- 'code'
22+
- 'pre'
23+
- 'blockquote'
24+
sources:
25+
- '*.md'
26+
- 'docs/*.md'

.github/wordlist.txt

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
FastAPI
2+
HashModel
3+
JsonModel
4+
PrimaryKeyCreator
5+
Pydantic
6+
Pydantic
7+
README
8+
RediSearch
9+
RediSearch
10+
RedisJSON
11+
SSL
12+
UlidPrimaryKey
13+
aioredis
14+
asyncio
15+
cls
16+
indexable
17+
md
18+
migrator
19+
py
20+
redisearch
21+
rediss
22+
subclasses
23+
subclassing
24+
utf
25+
CLI
26+
Pydantic's
27+
sortable
28+
subscripted
29+
unix
30+
localhost
31+
validators
32+
io
33+
ULIDs
34+
Deserializing
35+
virtualenv
36+
Bader's
37+
MacOS
38+
Homebrew
39+
WSL
40+
OM's

.github/workflows/spellcheck.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: spellcheck
2+
on:
3+
pull_request:
4+
jobs:
5+
check-spelling:
6+
runs-on: ubuntu-latest
7+
steps:
8+
- name: Checkout
9+
uses: actions/checkout@v3
10+
- name: Check Spelling
11+
uses: rojopolis/[email protected]
12+
with:
13+
config_path: .github/spellcheck-settings.yml
14+
task_name: Markdown

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,3 +138,6 @@ tests_sync/
138138

139139
# Apple Files
140140
.DS_Store
141+
142+
# spelling cruft
143+
*.dic

docs/validation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ Once again, we get the validation error:
131131

132132
## Constrained Values
133133

134-
If you want to use any of the constr
134+
If you want to use any of the constraints.
135135

136136
Pydantic includes many type annotations to introduce constraints to your model field values.
137137

0 commit comments

Comments
 (0)