You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by "Ufuk Celebi (JIRA)" <ji...@apache.org> on 2017/02/20 10:56:44 UTC
[jira] [Assigned] (FLINK-5780) Extend ConfigOption with
descriptions
[ https://issues.apache.org/jira/browse/FLINK-5780?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Ufuk Celebi reassigned FLINK-5780:
----------------------------------
Assignee: (was: Ufuk Celebi)
> 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)