apache / apache/lucene

Improve MIGRATE.txt for FieldsEnum/TermsEnum [LUCENE-3853]

Open
#4,926 7 comments 0 reactions 0 assignees View on GitHub
affects-version:4.0-ALPHA legacy-jira-priority:Major module:core/other type:bug
Dominant language
Java
Stars
3.6k
Forks
1.4k
Avg merge
2d 11h
Merged PRs (30d)
88

Description

The text in MIGRATE.txt that explains the new situation with FieldsEnum seems to be missing a level of object in explaining TermEnum. Perhaps it didn't keep with the code. here's a patch to MIGRATE.txt.

---
Migrated from [LUCENE-3853](https://issues.apache.org/jira/browse/LUCENE-3853) by Benson Margulies (@bimargulies-google)
Attachments: [LUCENE-3853.patch](https://apache.github.io/lucene-jira-archive/attachments/LUCENE-3853/LUCENE-3853.patch) (versions: 4)

Contributor guide

Open the contributing guide

Research direction

Start with MIGRATE.txt and the attached LUCENE-3853.patch, focusing on the FieldsEnum and TermEnum migration text. Compare the wording with the referenced migration change and correct the missing object level; done means MIGRATE.txt accurately explains the new TermsEnum structure.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.