Clarify what the score means in SpatialStrategy#makeQuery() [LUCENE-4616]
Open
legacy-jira-priority:Trivial
module:spatial
type:enhancement
- Dominant language
- Java
- Stars
- 3.6k
- Forks
- 1.4k
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 88
Description
SpatialStrategy#makeQuery() returns a Query, but the docs don't make it clear with the score value should be.
---
Migrated from [LUCENE-4616](https://issues.apache.org/jira/browse/LUCENE-4616) by Ryan McKinley (@ryantxu), updated Dec 28 2012
Contributor guide
Research direction
Start at the JavaDoc for SpatialStrategy#makeQuery(), the entry point named in the issue, and review how its returned Query uses the score value. Update the documentation to state what the score should mean; done when the expected score semantics are clear to callers.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- search
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100