Skip to content
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.

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

Fix typos in docs: it is 'match' field, not 'matches' #2

Merged
merged 1 commit into from
Dec 2, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ How it works

Instead of calling your script directly, you call it via `fuzzy.py`, which caches your script's output for the duration of the user session (as long as the user is using your workflow), and filters the items emitted by your script against the user's query using a fuzzy algorithm.

The query is compared to each item's `matches` field if it's present, and against the item's `title` field if not.
The query is compared to each item's `match` field if it's present, and against the item's `title` field if not.


<a name="example-usage"></a>
Expand Down
2 changes: 1 addition & 1 deletion fuzzy.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
workflow) to retrieve and cache all items, then the items are filtered
against the user query using a fuzzy matching algorithm.

Items are filtered on their `matches` field if present, otherwise on
Items are filtered on their `match` field if present, otherwise on
their `title` field.

"""
Expand Down