[
https://issues.apache.org/jira/browse/FLINK-8135?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16470640#comment-16470640
]
ASF GitHub Bot commented on FLINK-8135:
---------------------------------------
Github user zentol commented on a diff in the pull request:
https://github.com/apache/flink/pull/5985#discussion_r187378407
--- Diff:
flink-runtime/src/main/java/org/apache/flink/runtime/rest/messages/SubtaskIndexPathParameter.java
---
@@ -44,4 +44,9 @@ protected String convertToString(final Integer value) {
return value.toString();
}
+ @Override
+ public String getDescription() {
+ return "The index of a subtask. Integer value starts from 0,
should be positive.";
--- End diff --
_must_ be positive, same comment applies to other parameters
> Add description to MessageParameter
> -----------------------------------
>
> Key: FLINK-8135
> URL: https://issues.apache.org/jira/browse/FLINK-8135
> Project: Flink
> Issue Type: Improvement
> Components: Documentation, REST
> Reporter: Chesnay Schepler
> Assignee: Andrei
> Priority: Major
> Fix For: 1.5.0
>
>
> For documentation purposes we should add an {{getDescription()}} method to
> the {{MessageParameter}} class, describing what this particular parameter is
> used for and which values are accepted.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
