apache / apache/lucene

incorrect doc description of fielded query syntax [LUCENE-1765]

Open
#2,839 1 comment 0 reactions 0 assignees View on GitHub
affects-version:2.4.1 legacy-jira-priority:Minor type:bug website
Dominant language
Java
Stars
3.6k
Forks
1.4k
Avg merge
2d 11h
Merged PRs (30d)
88

Description

http://lucene.apache.org/java/2_4_1/queryparsersyntax.html#Fields says:

You can search any field by typing the field name followed by a colon ":" and then the term you are looking for.

This is slightly incomplete since the stuff after the fieldname can be a more complex query, not necessarily a term. For example,

title:(do it right)

seems to work when I tried it. It would be good if the doc was updated to describe the syntax exactly.

Also, "documentation" should be one of the components selectable in bug reports.

---
Migrated from [LUCENE-1765](https://issues.apache.org/jira/browse/LUCENE-1765) by solrize, updated Nov 30 2013
Environment:
```
lucene.apache.org docs
```

Contributor guide

Open the contributing guide

Research direction

Start with the linked Query Parser Syntax documentation at the Fields section and verify the example title:(do it right) against the described fielded-query syntax. Done means the documentation accurately describes that the value after a field name may be a complex query, and documentation is available as a bug-report component.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.