apache / apache/lucene

Rename some classes and methods in the search package so their names describe their roles [LUCENE-3173]

Open
#4,246 1 comment 0 reactions 0 assignees View on GitHub
affects-version:flexscoring branch legacy-jira-priority:Trivial module:core/search type:task
Dominant language
Java
Stars
3.6k
Forks
1.4k
Avg merge
2d 11h
Merged PRs (30d)
88

Description

In an IRC discussion with Robert Muir, it has come up that the names of certain classes and methods in the search package do not describe the role of the class or method in question. Therefore, we propose the following name changes:
- Scorer to Matcher
- Similarity.computeWeight() to Similarity.computeStats()
- Similarity.DocScorer to Similarity.Scorer\*

\*: Under consideration.

The reason for the name computeStats() is that this method will be used by the new Similarity subclasses to compute all the statistics they need, not just idf.

---
Migrated from [LUCENE-3173](https://issues.apache.org/jira/browse/LUCENE-3173) by David Mark Nemeskey
Parent: #4033
Attachments: [irc.log](https://apache.github.io/lucene-jira-archive/attachments/LUCENE-3173/irc.log)

Contributor guide

Open the contributing guide

Research direction

Start in the search package by locating Scorer, Similarity.computeWeight(), and Similarity.DocScorer, then read the parent issue #4033 and the attached IRC discussion for the naming context. Done means the agreed names are applied consistently across their references and the relevant search tests pass; confirm whether the DocScorer rename is still under consideration.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
search
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.