[lucene-solr] branch master updated: LUCENE-9053: improve FST's package-info.java comment to clarify required (Unicode code point) sort order for FST.Builder

[mi...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

mikemccand pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/lucene-solr.git


The following commit(s) were added to refs/heads/master by this push:
     new 8147e49  LUCENE-9053: improve FST's package-info.java comment to clarify required (Unicode code point) sort order for FST.Builder
8147e49 is described below

commit 8147e491ce3905bb3543f2c7e34a4ecb60382b49
Author: Mike McCandless <mi...@apache.org>
AuthorDate: Fri Jan 17 13:35:05 2020 -0500

    LUCENE-9053: improve FST's package-info.java comment to clarify required (Unicode code point) sort order for FST.Builder
---
 lucene/core/src/java/org/apache/lucene/util/fst/package-info.java | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/lucene/core/src/java/org/apache/lucene/util/fst/package-info.java b/lucene/core/src/java/org/apache/lucene/util/fst/package-info.java
index d984586..8ab7b66 100644
--- a/lucene/core/src/java/org/apache/lucene/util/fst/package-info.java
+++ b/lucene/core/src/java/org/apache/lucene/util/fst/package-info.java
@@ -34,7 +34,9 @@
  * <p>
  * FST Construction example:
  * <pre class="prettyprint">
- *     // Input values (keys). These must be provided to Builder in Unicode sorted order!
+ *     // Input values (keys). These must be provided to Builder in Unicode code point (UTF8 or UTF32) sorted order.
+ *     // Note that sorting by Java's String.compareTo, which is UTF16 sorted order, is not correct and can lead to
+ *     // exceptions while building the FST:
  *     String inputValues[] = {"cat", "dog", "dogs"};
  *     long outputValues[] = {5, 7, 12};
  *