Skip to content

Commit b0abd55

Browse files
authored
RESP 3 feature documentation (#2872)
1 parent a532f89 commit b0abd55

11 files changed

+331
-44
lines changed

.github/spellcheck-settings.yml

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

.github/wordlist.txt

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
APM
2+
ARGV
3+
BFCommands
4+
CFCommands
5+
CMSCommands
6+
ClusterNode
7+
ClusterNodes
8+
ClusterPipeline
9+
ClusterPubSub
10+
ConnectionPool
11+
CoreCommands
12+
EVAL
13+
EVALSHA
14+
GraphCommands
15+
Grokzen's
16+
INCR
17+
IOError
18+
Instrumentations
19+
JSONCommands
20+
Jaeger
21+
Ludovico
22+
Magnocavallo
23+
McCurdy
24+
NOSCRIPT
25+
NUMPAT
26+
NUMPT
27+
NUMSUB
28+
OSS
29+
OpenCensus
30+
OpenTelemetry
31+
OpenTracing
32+
Otel
33+
PubSub
34+
READONLY
35+
RediSearch
36+
RedisBloom
37+
RedisCluster
38+
RedisClusterCommands
39+
RedisClusterException
40+
RedisClusters
41+
RedisGraph
42+
RedisInstrumentor
43+
RedisJSON
44+
RedisTimeSeries
45+
SHA
46+
SearchCommands
47+
SentinelCommands
48+
SentinelConnectionPool
49+
Sharded
50+
Solovyov
51+
SpanKind
52+
Specfiying
53+
StatusCode
54+
TCP
55+
TOPKCommands
56+
TimeSeriesCommands
57+
Uptrace
58+
ValueError
59+
WATCHed
60+
WatchError
61+
api
62+
args
63+
async
64+
asyncio
65+
autoclass
66+
automodule
67+
backoff
68+
bdb
69+
behaviour
70+
bool
71+
boolean
72+
booleans
73+
bysource
74+
charset
75+
del
76+
dev
77+
eg
78+
exc
79+
firsttimersonly
80+
fo
81+
genindex
82+
gmail
83+
hiredis
84+
http
85+
idx
86+
iff
87+
ini
88+
json
89+
keyslot
90+
keyspace
91+
kwarg
92+
linters
93+
localhost
94+
lua
95+
makeapullrequest
96+
maxdepth
97+
mget
98+
microservice
99+
microservices
100+
mset
101+
multikey
102+
mykey
103+
nonatomic
104+
observability
105+
opentelemetry
106+
oss
107+
performant
108+
pmessage
109+
png
110+
pre
111+
psubscribe
112+
pubsub
113+
punsubscribe
114+
py
115+
pypi
116+
quickstart
117+
readonly
118+
readwrite
119+
redis
120+
redismodules
121+
reinitialization
122+
replicaof
123+
repo
124+
runtime
125+
sedrik
126+
sharded
127+
ssl
128+
str
129+
stunnel
130+
subcommands
131+
thevalueofmykey
132+
timeseries
133+
toctree
134+
topk
135+
tox
136+
triaging
137+
txt
138+
un
139+
unicode
140+
url
141+
virtualenv
142+
www

.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

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,13 +44,13 @@ Looking for a high-level library to handle object mapping? See [redis-om-python]
4444

4545
The most recent version of this library supports redis version [5.0](https://github.com/redis/redis/blob/5.0/00-RELEASENOTES), [6.0](https://github.com/redis/redis/blob/6.0/00-RELEASENOTES), [6.2](https://github.com/redis/redis/blob/6.2/00-RELEASENOTES), and [7.0](https://github.com/redis/redis/blob/7.0/00-RELEASENOTES).
4646

47-
The table below higlights version compatibility of the most-recent library versions and redis versions.
47+
The table below highlights version compatibility of the most-recent library versions and redis versions.
4848

4949
| Library version | Supported redis versions |
5050
|-----------------|-------------------|
5151
| 3.5.3 | <= 6.2 Family of releases |
5252
| >= 4.5.0 | Version 5.0 to 7.0 |
53-
| >= 5.0.0 | Versiond 5.0 to current |
53+
| >= 5.0.0 | Version 5.0 to current |
5454

5555

5656
## Usage

0 commit comments

Comments
 (0)