[ 
https://issues.apache.org/jira/browse/FLINK-8135?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16470639#comment-16470639
 ] 

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_r187382132
  
    --- Diff: 
flink-runtime/src/main/java/org/apache/flink/runtime/rest/messages/taskmanager/TaskManagerIdPathParameter.java
 ---
    @@ -41,4 +41,9 @@ protected ResourceID convertFromString(String value) {
        protected String convertToString(ResourceID value) {
                return value.getResourceIdString();
        }
    +
    +   @Override
    +   public String getDescription() {
    +           return "Task manager ID. Hexadecimal string representation of 
unique 16 bytes value.";
    --- End diff --
    
    I prefer `32 character hexadecimal string ...`.


> 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)

Reply via email to