You are viewing a plain text version of this content. The canonical link for it is here.

Posted to issues@flink.apache.org by "Chesnay Schepler (JIRA)" <ji...@apache.org> on 2016/08/01 16:32:20 UTC

[jira] [Commented] (FLINK-4302) Add JavaDocs to MetricConfig

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

Chesnay Schepler commented on FLINK-4302:
-----------------------------------------

that's a good idea.

We could also think about renaming the class to MetricProperties; should make it clearer to people what kind of object they are dealing with.

> Add JavaDocs to MetricConfig
> ----------------------------
>
>                 Key: FLINK-4302
>                 URL: https://issues.apache.org/jira/browse/FLINK-4302
>             Project: Flink
>          Issue Type: Improvement
>          Components: Metrics
>    Affects Versions: 1.1.0
>            Reporter: Ufuk Celebi
>
> {{MetricConfig}} has no comments at all. If you want to implement a custom reporter and you want to implement its {{open}} method, a {{MetricConfig}} is its argument. It will be helpful to add one class-level JavaDoc stating where the config values are coming from etc.
> [~Zentol] what do you think?



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)