Skip to content

Commit

Permalink
documented #177 github#48 exact,star variants of index option expand_…
Browse files Browse the repository at this point in the history
…keywords
  • Loading branch information
tomatolog committed Jan 29, 2018
1 parent abf8639 commit f9921a9
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions docs/conf_options_reference/index_configuration_options.rst
Expand Up @@ -832,8 +832,9 @@ Example:
expand_keywords
~~~~~~~~~~~~~~~

Expand keywords with exact forms and/or stars when possible. Optional,
default is 0 (do not expand keywords).
Expand keywords with exact forms and/or stars when possible. The value
can additionally enumerate options such us exact and star.
Optional, default is 0 (do not expand keywords).

Queries against indexes with ``expand_keywords`` feature enabled are
internally expanded as follows. If the index was built with prefix or
Expand All @@ -849,6 +850,14 @@ exact words) are combined:
running -> ( running | *running* | =running )
or expansion limited by exact option even infixes enabled for index

.. code-block:: ini
running -> ( running | =running )
Expanded queries take naturally longer to complete, but can possibly
improve the search quality, as the documents with exact form matches
Expand Down

0 comments on commit f9921a9

Please sign in to comment.