Skip to content

corrects typos in overview and getting started examples #135

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 9, 2024
Merged

corrects typos in overview and getting started examples #135

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/overview/cli.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
"source": [
"# Index\n",
"\n",
"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",
"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",
"\n",
"First, we will create an index from a yaml schema that looks like the following:\n"
]
Expand Down
2 changes: 1 addition & 1 deletion docs/overview/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ capability enabled when creating your database.

### Redis Stack (local development)

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

```bash
Expand Down
6 changes: 3 additions & 3 deletions docs/user_guide/getting_started_01.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
"fields:\n",
" - name: user\n",
" type: tag\n",
" - name: credit_store\n",
" - name: credit_score\n",
" type: tag\n",
" - name: job\n",
" type: text\n",
Expand Down Expand Up @@ -204,7 +204,7 @@
"source": [
"### Bring your own Redis connection instance\n",
"\n",
"This ideal in scenarious where you have custom settings on the connection instance or if your application will share a connection pool:"
"This is ideal in scenarios where you have custom settings on the connection instance or if your application will share a connection pool:"
]
},
{
Expand Down Expand Up @@ -570,7 +570,7 @@
" \"attrs\": {\n",
" \"dims\": 3,\n",
" \"distance_metric\": \"cosine\",\n",
" \"algorithm\": \"flat\",\n",
" \"algorithm\": \"hnsw\",\n",
" \"datatype\": \"float32\"\n",
" }\n",
" }\n",
Expand Down