Skip to content

docs(docarray): fix typo #325

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
hanxiao merged 1 commit into from
May 3, 2022
Merged

docs(docarray): fix typo #325

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/fundamentals/documentarray/access-elements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ da['@path1,path2,path3']

- The path-string must starts with `@`.
- Multiple paths are separated by comma `,`.
- A path represents the route from the top-level Documents to the destination. You can use `c` to select chunks, `cc` to select chunks of the chunks, `m` to select matches, `mc` to select matches of the chunks, `r` to select the top-level Documents.
- A path represents the route from the top-level Documents to the destination. You can use `c` to select chunks, `cc` to select chunks of the chunks, `m` to select matches, `mc` to select chunks of the matches, `r` to select the top-level Documents.
- A path can only go deep, not go back. You can use comma `,` to start a new path from the very top-level.
- Optionally, you can specify a slice or offset at each level, for example, `r[-1]m[:3]` will select the first 3 matches of the last root document.

Expand Down
2 changes: 1 addition & 1 deletion docs/fundamentals/documentarray/matching.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Though both `.find()` and `.match()` is about finding nearest neighbours of a gi

##### What is the return?
- `.find()` returns a List of DocumentArray, each of which corresponds to one element/row in the query.
- `.match()` do not return anything. Match results are stored inside right-hand side's `.matches`.
- `.match()` do not return anything. Match results are stored inside left-hand side's `.matches`.

In the sequel, we will use `.match()` to describe the features. But keep in mind that `.find()` should also work by simply switching the right and left-hand sides.

Expand Down