Skip to content

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

Merged
cpoerschke merged 1 commit intoapache:mainfrom
malliaridis:documentation/fix-boolean-operator
Jul 3, 2024
Merged

SOLR-17358: Escape + symbol to render documentation correctly#2547
cpoerschke merged 1 commit intoapache:mainfrom
malliaridis:documentation/fix-boolean-operator

Conversation

@malliaridis
Copy link
Contributor

https://issues.apache.org/jira/browse/SOLR-17358

Description

Fix minor rendering issue to show + symbol again in documentation.

Note that escaping with double backticks doesn't seem to work in this scenario.

Checklist

Please review the following and check all that apply:

  • I have reviewed the guidelines for How to Contribute and my code conforms to the standards described there to the best of my ability.
  • I have created a Jira issue and added the issue ID to my pull request title.
  • I have given Solr maintainers access to contribute to my PR branch. (optional but recommended)
  • I have developed this patch against the main branch.
  • I have run ./gradlew check.
  • I have added tests for my changes.
  • I have added documentation for the Reference Guide

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jul 2, 2024
=== 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

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

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.

@cpoerschke cpoerschke merged commit c421288 into apache:main Jul 3, 2024
asfgit pushed a commit that referenced this pull request Jul 3, 2024
@malliaridis malliaridis deleted the documentation/fix-boolean-operator branch July 3, 2024 13:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Comments