apache / apache/lucene

Reconsider FunctionValues / ValueSource API [LUCENE-4412]

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

Description

When documenting a lot of these classes today I found myself confused and it isn't the first time with this API.

I think we need to step back and reassess what we want from this API, what use cases its designed to meet, and redesign it from the ground up.

---
Migrated from [LUCENE-4412](https://issues.apache.org/jira/browse/LUCENE-4412) by Chris Male, updated May 09 2016

Contributor guide

Open the contributing guide

Research direction

The issue names the FunctionValues and ValueSource APIs but no files, tests, or entry points. Start by reviewing those APIs and documenting their intended use cases; the work is only done once a concrete redesign scope and agreed implementation plan exist.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
search
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
15/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.