apache / apache/lucene

Update Javadoc about normalizeEntry in Kuromoji DictionaryBuilder [LUCENE-9270]

Open
#10,310 2 comments 0 reactions 1 assignee Claimed by @danmuzi View on GitHub
legacy-jira-priority:Major type:enhancement
Dominant language
Java
Stars
3.6k
Forks
1.4k
Avg merge
2d 11h
Merged PRs (30d)
88

Description

The normalizeEntry option is missing from the Javadoc of Kuromoji DictionaryBuilder.
Without this explanation, users don't know what it means until they see the code.
Also, if user follows the usage of Javadoc, it will not be built.

So the following contents need to be applied:

1) Change usage
before:
  java -cp [lucene classpath] org.apache.lucene.analysis.ja.util.DictionaryBuilder \
    ${inputDir} ${outputDir} ${encoding}
after:
  java -cp [lucene classpath] org.apache.lucene.analysis.ja.util.DictionaryBuilder \
    ${inputDir} ${outputDir} ${encoding} **${normalizeEntry}**

2) Add description about normalizeEntry

---
Migrated from [LUCENE-9270](https://issues.apache.org/jira/browse/LUCENE-9270) by Namgyu Kim (@danmuzi), updated Mar 11 2020

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.