Skip to content

Commit 66ef8b8

Browse files
justin-cechmanekJustin Cechmanek
andauthored
corrects typos in overview and getting started examples (#135)
This address a few minor typos I came across while working through the examples. Co-authored-by: Justin Cechmanek <justin.cechmanek@justin.cechmanek-HQM60FP16H>
1 parent f297133 commit 66ef8b8

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

docs/overview/cli.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
"source": [
4040
"# Index\n",
4141
"\n",
42-
"The ``rvl index`` command is can be used for a number of tasks related to creating and managing indices. Wether you are working in Python or another language, this cli tool can still be useful for managing and inspecting your indices.\n",
42+
"The ``rvl index`` command can be used for a number of tasks related to creating and managing indices. Wether you are working in Python or another language, this cli tool can still be useful for managing and inspecting your indices.\n",
4343
"\n",
4444
"First, we will create an index from a yaml schema that looks like the following:\n"
4545
]

docs/overview/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ capability enabled when creating your database.
6969

7070
### Redis Stack (local development)
7171

72-
For local development and testing, Redis-Stack and be used. We recommend running Redis
72+
For local development and testing, Redis-Stack can be used. We recommend running Redis
7373
in a docker container. To do so, run the following command:
7474

7575
```bash

docs/user_guide/getting_started_01.ipynb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
"fields:\n",
5656
" - name: user\n",
5757
" type: tag\n",
58-
" - name: credit_store\n",
58+
" - name: credit_score\n",
5959
" type: tag\n",
6060
" - name: job\n",
6161
" type: text\n",
@@ -204,7 +204,7 @@
204204
"source": [
205205
"### Bring your own Redis connection instance\n",
206206
"\n",
207-
"This ideal in scenarious where you have custom settings on the connection instance or if your application will share a connection pool:"
207+
"This is ideal in scenarios where you have custom settings on the connection instance or if your application will share a connection pool:"
208208
]
209209
},
210210
{
@@ -570,7 +570,7 @@
570570
" \"attrs\": {\n",
571571
" \"dims\": 3,\n",
572572
" \"distance_metric\": \"cosine\",\n",
573-
" \"algorithm\": \"flat\",\n",
573+
" \"algorithm\": \"hnsw\",\n",
574574
" \"datatype\": \"float32\"\n",
575575
" }\n",
576576
" }\n",

0 commit comments

Comments
 (0)