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

Documentation: no description for the $text operator #1454

Closed
shimaore opened this issue Jul 18, 2018 · 1 comment
Closed

Documentation: no description for the $text operator #1454

shimaore opened this issue Jul 18, 2018 · 1 comment

Comments

@shimaore
Copy link

Expected Behavior

The documentation should contain a description of the $text operator, or the operator should be removed from the examples if it is not supported.

Current Behavior

The documentation for the selectors syntax uses $text in the examples, but the operator is never described.

A quick browse through the code(?) suggests this might be because this operator might depend on Lucene.

Possible Solution

If the operator depends on Lucene and is not documented because Lucene is not included in the default install, the examples should be reworked to not include the operator.

@wohali
Copy link
Member

wohali commented Jul 18, 2018

@shimaore correct, this requires the clouseau/dreyfus addon from Cloudant. We are unable to ship this add-on due to licensing restrictions as part of CouchDB. However, the $text operator is supported by Mango if this add-on is installed.

I will reopen this against our documentation repository. A pull request to remove the references would be welcome!

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

2 participants