[
https://issues.apache.org/jira/browse/FLINK-5780?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Chesnay Schepler closed FLINK-5780.
-----------------------------------
Resolution: Fixed
Fix Version/s: 1.4.0
1.4: b54a72e4507b0d968c8209f2c447729b51d5d3bd
> 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
> Assignee: Dawid Wysakowicz
> Fix For: 1.4.0
>
>
> 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)
