Skip to content

Commit

Permalink
RESP 3 feature documentation (#2872)
Browse files Browse the repository at this point in the history
  • Loading branch information
chayim committed Aug 8, 2023
1 parent a532f89 commit b0abd55
Show file tree
Hide file tree
Showing 11 changed files with 331 additions and 44 deletions.
29 changes: 29 additions & 0 deletions .github/spellcheck-settings.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
matrix:
- name: Markdown
expect_match: false
apsell:
lang: en
d: en_US
ignore-case: true
dictionary:
wordlists:
- .github/wordlist.txt
output: wordlist.dic
pipeline:
- pyspelling.filters.markdown:
markdown_extensions:
- markdown.extensions.extra:
- pyspelling.filters.html:
comments: false
attributes:
- alt
ignores:
- ':matches(code, pre)'
- code
- pre
- blockquote
- img
sources:
- '*.md'
- 'docs/*.rst'
- 'docs/*.ipynb'
142 changes: 142 additions & 0 deletions .github/wordlist.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
APM
ARGV
BFCommands
CFCommands
CMSCommands
ClusterNode
ClusterNodes
ClusterPipeline
ClusterPubSub
ConnectionPool
CoreCommands
EVAL
EVALSHA
GraphCommands
Grokzen's
INCR
IOError
Instrumentations
JSONCommands
Jaeger
Ludovico
Magnocavallo
McCurdy
NOSCRIPT
NUMPAT
NUMPT
NUMSUB
OSS
OpenCensus
OpenTelemetry
OpenTracing
Otel
PubSub
READONLY
RediSearch
RedisBloom
RedisCluster
RedisClusterCommands
RedisClusterException
RedisClusters
RedisGraph
RedisInstrumentor
RedisJSON
RedisTimeSeries
SHA
SearchCommands
SentinelCommands
SentinelConnectionPool
Sharded
Solovyov
SpanKind
Specfiying
StatusCode
TCP
TOPKCommands
TimeSeriesCommands
Uptrace
ValueError
WATCHed
WatchError
api
args
async
asyncio
autoclass
automodule
backoff
bdb
behaviour
bool
boolean
booleans
bysource
charset
del
dev
eg
exc
firsttimersonly
fo
genindex
gmail
hiredis
http
idx
iff
ini
json
keyslot
keyspace
kwarg
linters
localhost
lua
makeapullrequest
maxdepth
mget
microservice
microservices
mset
multikey
mykey
nonatomic
observability
opentelemetry
oss
performant
pmessage
png
pre
psubscribe
pubsub
punsubscribe
py
pypi
quickstart
readonly
readwrite
redis
redismodules
reinitialization
replicaof
repo
runtime
sedrik
sharded
ssl
str
stunnel
subcommands
thevalueofmykey
timeseries
toctree
topk
tox
triaging
txt
un
unicode
url
virtualenv
www
14 changes: 14 additions & 0 deletions .github/workflows/spellcheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: spellcheck
on:
pull_request:
jobs:
check-spelling:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Check Spelling
uses: rojopolis/spellcheck-github-actions@0.33.1
with:
config_path: .github/spellcheck-settings.yml
task_name: Markdown
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,13 @@ Looking for a high-level library to handle object mapping? See [redis-om-python]

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).

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

| Library version | Supported redis versions |
|-----------------|-------------------|
| 3.5.3 | <= 6.2 Family of releases |
| >= 4.5.0 | Version 5.0 to 7.0 |
| >= 5.0.0 | Versiond 5.0 to current |
| >= 5.0.0 | Version 5.0 to current |


## Usage
Expand Down
Loading

0 comments on commit b0abd55

Please sign in to comment.