[
https://issues.apache.org/jira/browse/FLINK-2654?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14738910#comment-14738910
]
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_r39173067
--- Diff:
flink-java/src/main/java/org/apache/flink/api/java/utils/ParameterTool.java ---
@@ -136,15 +157,35 @@ public static ParameterTool fromPropertiesFile(String
path) throws IOException {
return fromMap((Map)props);
}
+ /**
+ * Returns {@link ParameterTool} for the given map
+ *
+ * @param map A map of arguments. Both Key and Value have to be Strings
+ * @return A {@link ParameterTool}
+ */
public static ParameterTool fromMap(Map<String, String> map) {
Preconditions.checkNotNull(map, "Unable to initialize from
empty map");
return new ParameterTool(map);
}
+ /**
+ * Returns {@link ParameterTool} from the system properties
--- End diff --
Maybe it would make sense to add that people can pass system properties to
the jvm using `-Dkey=value`.
> 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)
