Skip to content

Commit 8dab1e4

Browse files
committed
Update docs
1 parent cd37fe9 commit 8dab1e4

File tree

2 files changed

+6
-7
lines changed

2 files changed

+6
-7
lines changed

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -121,19 +121,18 @@ Choose from multiple Redis deployment options:
121121
})
122122
```
123123

124-
2. [Create a SearchIndex](https://docs.redisvl.com/en/stable/user_guide/01_getting_started.html#create-a-searchindex) class with an input schema and client connection in order to perform admin and search operations on your index in Redis:
124+
2. [Create a SearchIndex](https://docs.redisvl.com/en/stable/user_guide/01_getting_started.html#create-a-searchindex) class with an input schema to perform admin and search operations on your index in Redis:
125125
```python
126126
from redis import Redis
127127
from redisvl.index import SearchIndex
128128
129-
# Establish Redis connection and define index
130-
client = Redis.from_url("redis://localhost:6379")
131-
index = SearchIndex(schema, client)
129+
# Define the index
130+
index = SearchIndex(schema, redis_url="redis://localhost:6379")
132131
133132
# Create the index in Redis
134133
index.create()
135134
```
136-
> Async compliant search index class also available: [AsyncSearchIndex](https://docs.redisvl.com/en/stable/api/searchindex.html#redisvl.index.AsyncSearchIndex).
135+
> An async-compatible index class also available: [AsyncSearchIndex](https://docs.redisvl.com/en/stable/api/searchindex.html#redisvl.index.AsyncSearchIndex).
137136

138137
3. [Load](https://docs.redisvl.com/en/stable/user_guide/01_getting_started.html#load-data-to-searchindex)
139138
and [fetch](https://docs.redisvl.com/en/stable/user_guide/01_getting_started.html#fetch-an-object-from-redis) data to/from your Redis instance:
@@ -346,7 +345,7 @@ Commands:
346345
stats Obtain statistics about an index
347346
```
348347
349-
> Read more about [using the CLI](https://docs.redisvl.com/en/stable/user_guide/cli.html).
348+
> Read more about [using the CLI](https://docs.redisvl.com/en/latest/overview/cli.html).
350349
351350
## 🚀 Why RedisVL?
352351

tests/integration/test_async_search_index.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ async def test_search_index_set_client(client, redis_url, index_schema):
160160
await async_index.create(overwrite=True, drop=True)
161161
assert isinstance(async_index.client, Redis)
162162

163-
# Tests deprecated sync -> async conversation behavior
163+
# Tests deprecated sync -> async conversion behavior
164164
assert isinstance(client, SyncRedis)
165165
await async_index.set_client(client)
166166
assert isinstance(async_index.client, Redis)

0 commit comments

Comments
 (0)