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

Docs examples for custom indexes should mention registration #68

Open
Tracked by #83
emilytoppm opened this issue Jun 14, 2024 · 0 comments
Open
Tracked by #83

Docs examples for custom indexes should mention registration #68

emilytoppm opened this issue Jun 14, 2024 · 0 comments

Comments

@emilytoppm
Copy link
Member

Currently, uses of .query or similar methods on custom indexes, created following the examples at https://github.com/wagtail/wagtail-vector-index/blob/main/docs/vector-indexes.md fail with a KeyError unless registered like https://github.com/wagtail/wagtail-vector-index/blob/main/tests/testapp/models.py#L40. We should document this and make sure the examples contain the decorator so they work out of the box.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant