[
https://issues.apache.org/jira/browse/FLINK-2654?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14738920#comment-14738920
]
ASF GitHub Bot commented on FLINK-2654:
---------------------------------------
Github user rmetzger commented on a diff in the pull request:
https://github.com/apache/flink/pull/1116#discussion_r39173419
--- Diff:
flink-java/src/main/java/org/apache/flink/api/java/utils/ParameterTool.java ---
@@ -245,13 +310,20 @@ public long getLong(String key, long defaultValue) {
}
// -------------- FLOAT
-
+ /**
+ * Returns the Float value for the given key.
+ * The method fails if the key does not exist.
+ */
public float getFloat(String key) {
addToDefaults(key, null);
String value = getRequired(key);
return Float.valueOf(value);
}
+ /**
+ * Returns the Float value for the given key. If the key does not
exists it will return the default value given.
+ * The method fails if the value is not an Float.
--- End diff --
an float.
> Add JavaDoc to ParameterTool class
> ----------------------------------
>
> Key: FLINK-2654
> URL: https://issues.apache.org/jira/browse/FLINK-2654
> Project: Flink
> Issue Type: Improvement
> Reporter: Behrouz Derakhshan
> Priority: Minor
>
> ParameterTool class is missing JavaDocs
> The tool is already being used, and the plan is to use it in all of the
> example codes. We should add JavaDocs before start using it.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
