4907 Tweaked advanced search documentation to include new search operators #4909
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…h operators Fixes: #4907
mlissner
approved these changes
Jan 11, 2025
| @@ -34,7 +34,7 @@ <h2 class="alt"> | |||
| {% elif error_message == "unbalanced_quotes" %} | |||
| Did you forget to close one or more quotes? | |||
| {% elif error_message == "disallowed_wildcard_pattern" %} | |||
| The query contains a disallowed expensive wildcard pattern. | |||
| The query contains a <a href="{% url "advanced_search" %}#disallowed-expensive-wildcards">disallowed expensive wildcard</a> pattern. | |||
There was a problem hiding this comment.
I don't think most people understand what it means to be an "expensive" wildcard, so, I suggest:
Suggested change
| The query contains a <a href="{% url "advanced_search" %}#disallowed-expensive-wildcards">disallowed expensive wildcard</a> pattern. | |
| The query contains a <a href="{% url "advanced_search" %}#disallowed-expensive-wildcards">disallowed wildcard</a> pattern. |
There was a problem hiding this comment.
Sure, removed expensive. Also removed from the API error message.
|
|
||
| <p>The question mark character (<strong>?</strong>) can be used similarly as a single letter wildcard. For example, this would find cases containing the word "immigrant" or "emmigration": <code>?mmigra*</code> | ||
| </p> | ||
| <p><code>*</code> can also be used inside words, where it acts as a single-character wildcard. For example, a query like <code>gr*mm*r</code> would match cases containing both "gr<strong>a</strong>mm<strong>a</strong>r" and "gr<strong>i</strong>mm<strong>e</strong>r".</p> |
There was a problem hiding this comment.
I think we need <nobr>'s here, right?
Suggested change
| <p><code>*</code> can also be used inside words, where it acts as a single-character wildcard. For example, a query like <code>gr*mm*r</code> would match cases containing both "gr<strong>a</strong>mm<strong>a</strong>r" and "gr<strong>i</strong>mm<strong>e</strong>r".</p> | |
| <p><code>*</code> can also be used inside words, where it acts as a single-character wildcard. For example, a query like <nobr><code>gr*mm*r</code></nobr> would match cases containing both <nobr>"gr<strong>a</strong>mm<strong>a</strong>r"</nobr> and <nobr>"gr<strong>i</strong>mm<strong>e</strong>r"</nobr>.</p> |
There was a problem hiding this comment.
I found that <nobr> is deprecated and is no longer recommended for use.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/nobr
Instead used text-nowrap css class.
|
|
||
| <p>Queries that match multiple endings are only allowed if the base word has at least three characters. Therefore, queries like <code>a*</code>, <code>bc*</code>, <code>!a</code>, or <code>!bc</code> are disallowed due to performance issues.</p> | ||
| <p>Performing a query like these will throw an error with the message:</p> | ||
| <p><code>The query contains a disallowed expensive wildcard pattern.</code></p> |
There was a problem hiding this comment.
Suggested change
| <p><code>The query contains a disallowed expensive wildcard pattern.</code></p> | |
| <p><code>The query contains a disallowed wildcard pattern.</code></p> |
There was a problem hiding this comment.
Removed. Also from the section title, now just Disallowed Wildcards
|
Thanks! Suggestions applied. |
mlissner
merged commit f8645e7
into
3888-support-additional-search-connectors
7 checks passed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes: #4907
Included & operator to AND documentation.
Added But not documentation
Tweaked the Wildcards documentation to reflect the new behavior of
*and!and updated fuzzy search documentation according to ES behaviour:Added documentation about disallowed expensive wildcard patterns:
Linked disallowed expensive wildcard error message to documentation:
Fixed the
/sand/psyntax error message to correctly refer to a proximity query example instead of a fuzzy query, as it did previously.