Improve Javadoc of PointValues [LUCENE-7535]
Open
affects-version:6.2.1
legacy-jira-priority:Major
type:documentation
type:enhancement
- Dominant language
- Java
- Stars
- 3.6k
- Forks
- 1.4k
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 88
Description
I was a bit confused by the performance characteristics of the new point queries for exact matches. It might make sense to add an explanation to the Javadoc.
---
Migrated from [LUCENE-7535](https://issues.apache.org/jira/browse/LUCENE-7535) by Florian Hopf (@fhopf)
Attachments: [LUCENE-7535.patch](https://apache.github.io/lucene-jira-archive/attachments/LUCENE-7535/LUCENE-7535.patch)
Contributor guide
Research direction
Locate the PointValues API and read its existing Javadoc alongside the documentation for exact-match point queries. Clarify the performance characteristics requested in the issue, then update the relevant Javadoc and verify that the explanation accurately matches the existing point-query behavior.
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
- 45/100