From 167c65afadc164beb870337a1076ef146387b55d Mon Sep 17 00:00:00 2001 From: Uwe Schindler Date: Thu, 18 Oct 2018 12:36:16 +0200 Subject: [PATCH] LUCENE-8533: Fix Javadocs of DataInput#readVInt(): Negative numbers are supported, but should be avoided. --- lucene/CHANGES.txt | 3 +++ lucene/core/src/java/org/apache/lucene/store/DataInput.java | 4 ++-- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/lucene/CHANGES.txt b/lucene/CHANGES.txt index 7a181bd2407..50b1cf397ec 100644 --- a/lucene/CHANGES.txt +++ b/lucene/CHANGES.txt @@ -208,6 +208,9 @@ Other: * LUCENE-8523: Correct typo in JapaneseNumberFilterFactory javadocs (Ankush Jhalani via Alan Woodward) +* LUCENE-8533: Fix Javadocs of DataInput#readVInt(): Negative numbers are + supported, but should be avoided. (Vladimir Dolzhenko via Uwe Schindler) + ======================= Lucene 7.5.1 ======================= Bug Fixes: diff --git a/lucene/core/src/java/org/apache/lucene/store/DataInput.java b/lucene/core/src/java/org/apache/lucene/store/DataInput.java index d8349959add..2514b841c49 100644 --- a/lucene/core/src/java/org/apache/lucene/store/DataInput.java +++ b/lucene/core/src/java/org/apache/lucene/store/DataInput.java @@ -103,8 +103,8 @@ public abstract class DataInput implements Cloneable { } /** Reads an int stored in variable-length format. Reads between one and - * five bytes. Smaller values take fewer bytes. Negative numbers are not - * supported. + * five bytes. Smaller values take fewer bytes. Negative numbers are + * supported, but should be avoided. *

* The format is described further in {@link DataOutput#writeVInt(int)}. *