Skip to content

Commit 1cec966

Browse files
authored
docs: fixes a bunch of typos (#628)
1 parent 800ceb2 commit 1cec966

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

docs/docs/about/contributing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Following the steps below to get cocoindex build on latest codebase locally - if
3838
```bash
3939
python3 -m venv .venv
4040
```
41-
Activate the virtual environment, before any installings / buildings / runnings:
41+
Activate the virtual environment, before any installing / building / running:
4242
4343
```bash
4444
. .venv/bin/activate

docs/docs/core/basics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ For the example shown in the [Quickstart](../getting_started/quickstart) section
5050

5151
This creates the following data for the indexing flow:
5252

53-
* The `Localfile` source creates a `documents` field at the top level, with `filename` (key) and `content` sub fields.
53+
* The `LocalFile` source creates a `documents` field at the top level, with `filename` (key) and `content` sub fields.
5454
* A "for each" action works on each document, with the following transformations:
5555
* The `SplitRecursively` function splits content into chunks, adds a `chunks` field into the current scope (each document), with `location` (key) and `text` sub fields.
5656
* A "collect" action works on each chunk, with the following transformations:

docs/docs/core/custom_function.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Notes:
8484

8585
### Function Executor
8686

87-
A function executor defines behavior of a function. It's initantiated for each operation that uses this function.
87+
A function executor defines behavior of a function. It's instantiated for each operation that uses this function.
8888

8989
The function executor is responsible for:
9090

@@ -117,7 +117,7 @@ Notes:
117117
* The `cocoindex.op.executor_class()` class decorator also takes optional parameters.
118118
See [Parameters for custom functions](#parameters-for-custom-functions) for details.
119119

120-
* A `spec` field must be present in the class, and must be annoated with the spec class name.
120+
* A `spec` field must be present in the class, and must be annotated with the spec class name.
121121
* The `prepare()` method is optional. It's executed once and only once before any `__call__` execution, to prepare the function execution.
122122
* The `__call__()` method is required. It's executed for each specific rows of data.
123123
Types of arugments and the return value must be decorated, so that CocoIndex will have information about data types of the operation's output fields.

0 commit comments

Comments
 (0)