This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-text.git
The following commit(s) were added to refs/heads/master by this push:
new c615351 Correct Javadoc in FileStringLookup.
c615351 is described below
commit c615351ac89e9efdfb39a9e24c03ce52fc2fe075
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Fri Jul 23 13:34:17 2021 -0400
Correct Javadoc in FileStringLookup.
---
src/changes/changes.xml | 1 +
src/main/java/org/apache/commons/text/lookup/FileStringLookup.java | 6 +++---
2 files changed, 4 insertions(+), 3 deletions(-)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index bade7a4..851a487 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -51,6 +51,7 @@ The <action> type attribute can be add,update,fix,remove.
<action issue="TEXT-158" type="fix" dev="kinow">Incorrect values for
Jaccard similarity with empty strings.</action>
<action issue="TEXT-186" type="fix" dev="ggregory" due-to="Gautam Korlam,
Gary Gregory">StringSubstitutor map constructor throws NPE on 1.9 with null
map.</action>
<action issue="TEXT-191" type="fix" dev="kinow" due-to="Bradley David
Rumball">JaroWinklerDistance returns the same values as
JaroWinklerSimilarity.</action>
+ <action type="add" dev="ggregory" due-to="Gary
Gregory">Correct Javadoc in FileStringLookup.</action>
<!-- ADD -->
<action issue="TEXT-207" type="add" dev="mattjuntunen">Add DoubleFormat
utility.</action>
<action issue="TEXT-190" type="add" dev="kinow" due-to="Benjamin
Bing">Document negative limit for WordUtils abbreviate method</action>
diff --git a/src/main/java/org/apache/commons/text/lookup/FileStringLookup.java
b/src/main/java/org/apache/commons/text/lookup/FileStringLookup.java
index de15027..e430ea2 100644
--- a/src/main/java/org/apache/commons/text/lookup/FileStringLookup.java
+++ b/src/main/java/org/apache/commons/text/lookup/FileStringLookup.java
@@ -24,7 +24,7 @@ import org.apache.commons.lang3.StringUtils;
import org.apache.commons.text.StringSubstitutor;
/**
- * Looks up keys from an XML document.
+ * Looks up keys from a file.
* <p>
* Using a {@link StringLookup} from the {@link StringLookupFactory}:
* </p>
@@ -60,9 +60,9 @@ final class FileStringLookup extends AbstractStringLookup {
}
/**
- * Looks up the value for the key in the format "DocumentPath:XPath".
+ * Looks up the value for the key in the format "charsetName:DocumentPath".
* <p>
- * For example: "com/domain/document.xml:/path/to/node".
+ * For example: "UTF-8:com/domain/document.properties".
* </p>
*
* @param key the key to be looked up, may be null
