flink-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (FLINK-8135) Add description to MessageParameter
Date Mon, 14 May 2018 12:52:00 GMT

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

ASF GitHub Bot commented on FLINK-8135:
---------------------------------------

Github user andrew-half commented on a diff in the pull request:

    https://github.com/apache/flink/pull/5985#discussion_r187940843
  
    --- Diff: flink-runtime/src/main/java/org/apache/flink/runtime/rest/messages/job/metrics/MetricsAggregationParameter.java
---
    @@ -46,6 +46,13 @@ public String convertValueToString(AggregationMode value) {
     		return value.name().toLowerCase();
     	}
     
    +	@Override
    +	public String getDescription() {
    +		return "Comma-separated list of aggregates which should be calculated. Available aggregations
are " +
    +			" \"sum\", \"max\", \"min\" and \"avg\". Unknown aggregations are ignored. " +
    --- End diff --
    
    In some cases a user should know that mistakes can be hidden without warnings.


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

Mime
View raw message