Skip to content

SOLR-17358: Escape + symbol to render documentation correctly #2547

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.

Sign up for GitHub

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

Merged
cpoerschke merged 1 commit into from
Jul 3, 2024
Merged

SOLR-17358: Escape + symbol to render documentation correctly #2547

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 solr/solr-ref-guide/modules/query-guide/pages/standard-query-parser.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@ or

=== The Boolean Operator "+"

The `+` symbol (also known as the "required" operator) requires that the term after the `+` symbol exist somewhere in a field in at least one document in order for the query to return a match.
The `\+` symbol (also known as the "required" operator) requires that the term after the `+` symbol exist somewhere in a field in at least one document in order for the query to return a match.
Copy link
Contributor

@cpoerschke cpoerschke Jul 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for spotting and sending PR to fix! Maybe one more here?

Suggested change
The `\+` symbol (also known as the "required" operator) requires that the term after the `+` symbol exist somewhere in a field in at least one document in order for the query to return a match.
The `\+` symbol (also known as the "required" operator) requires that the term after the `\+` symbol exist somewhere in a field in at least one document in order for the query to return a match.

Copy link
Contributor Author

@malliaridis malliaridis Jul 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought so too, but apparently because the sentence ends without another quoted + sign, ASCIIDoc recognizes the second one correctly. Escaping it would also display the escape character together with the + sign. Weird behavior if you ask me.


For example, to search for documents that must contain "jakarta" and that may or may not contain "lucene," use the following query:

Expand Down