apache / apache/lucene

queryparsersyntax.html escaping section needs beefed up [LUCENE-1000]

Open
#2,076 3 comments 0 reactions 0 assignees View on GitHub
legacy-jira-fix-version:4.9 legacy-jira-fix-version:6.0 legacy-jira-label:newdev legacy-jira-priority:Major type:enhancement website
Dominant language
Java
Stars
3.6k
Forks
1.4k
Avg merge
2d 11h
Merged PRs (30d)
88

Description

the query syntax documentation is currently lacking several key pieces of info:
1) that unicode style escapes are valid
2) that any character can be escaped with a backslash, not just special chars.

..we should probably beef up the "Escaping Special Characters" section

---
Migrated from [LUCENE-1000](https://issues.apache.org/jira/browse/LUCENE-1000) by Chris M. Hostetter (@hossman), 1 vote, updated May 09 2016
Linked issues:
- #2199

Contributor guide

Open the contributing guide

Research direction

Start with queryparsersyntax.html and review the "Escaping Special Characters" section. Document that Unicode-style escapes are valid and that a backslash can escape any character, then confirm the section clearly covers both points.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, search
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.