Documentation Update for JQL Search with Special Characters

Definition

As per this documentation, it should be possible to search in the issue navigator using special characters.

JIRA supports the ability to search issues for special characters by escaping them in your query syntax. The current list of such characters is:

+ - & | ! ( ) { } [ ] ^ ~ * ? \ :

However, it is not working as expected. Searching like summary !~ "
]" fails with error "The text query ']' for field 'summary' is not valid: the '*' and '?' are not allowed as first character in wildcard query" and summary !~ "
]" returns all the issues.

I came across to this bug report which was eventually not closed as Answered.

To do this we use Lucene's ClassicTokenizer which:

1. Splits words at punctuation characters, removing punctuation. However, a dot that's not followed by whitespace is considered part of a token.
2. Splits words at hyphens, unless there's a number in the token, in which case the whole token is interpreted as a product number and is not split.
3. Recognizes email addresses and internet hostnames as one token.

As a result the "[" and "]" characters are neither added to the index or retained in the phrase query.

There were comments about documentation update to avoid confusion but there was no follow up whether a ticket has been created for that or not. So here it is.