[ https://issues.apache.org/jira/browse/FLINK-5780?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15875418#comment-15875418 ]
shijinkui commented on FLINK-5780: ---------------------------------- Just sound like a extension of apache common-cli. https://commons.apache.org/proper/commons-cli/ IMO, commonk-cli style is the standard, i like it. Is that so? > 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)