apache / apache/lucene

MIGRATE/CHANGES.txt need improved Points verbage [LUCENE-7076]

Open
#8,132 8 comments 0 reactions 0 assignees View on GitHub
legacy-jira-priority:Major type:task
Dominant language
Java
Stars
3.6k
Forks
1.4k
Avg merge
2d 11h
Merged PRs (30d)
88

Description

for MIGRATE.txt, we should have some more verbage, maybe examples of how to index/search a 1D integer. maybe even better, it could be done in javadocs and referenced here as well.

CHANGES.txt I think we should organize so it looks more like changes entry for flexible indexing or other similar big changes, and there is a coherent summary of what happened.

---
Migrated from [LUCENE-7076](https://issues.apache.org/jira/browse/LUCENE-7076) by Robert Muir (@rmuir), updated Mar 09 2016
Attachments: [LUCENE-7076.patch](https://apache.github.io/lucene-jira-archive/attachments/LUCENE-7076/LUCENE-7076.patch)

Contributor guide

Open the contributing guide

Research direction

Start by reading MIGRATE.txt and the relevant CHANGES.txt entries, then review the LUCENE-7076 attachment and any existing javadocs for flexible indexing. Clarify the intended 1D integer indexing/search examples and the desired changes-summary structure. Done means MIGRATE.txt provides useful guidance and CHANGES.txt gives a coherent account, with javadocs referenced if appropriate.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.