[jira] [Commented] (FLINK-5780) Extend ConfigOption with descriptions

["Jark Wu (JIRA)" <ji...@apache.org>]

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

Jark Wu commented on FLINK-5780:
--------------------------------

Hi [~uce], why do we need short and long description ? Does a `description(String)` method enough ?

Besides, I find that Kafka has an addition fields, called `importance` used to sort config keys, do we need that ?  

> Extend ConfigOption with descriptions
> -------------------------------------
>
>                 Key: FLINK-5780
>                 URL: https://issues.apache.org/jira/browse/FLINK-5780
>             Project: Flink
>          Issue Type: Sub-task
>          Components: Core, Documentation
>            Reporter: Ufuk Celebi
>
> The {{ConfigOption}} type is meant to replace the flat {{ConfigConstants}}. As part of automating the generation of a docs config page we need to extend  {{ConfigOption}} with description fields.
> From the ML discussion, these could be:
> {code}
> void shortDescription(String);
> void longDescription(String);
> {code}
> In practice, the description string should contain HTML/Markdown.



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)