flink-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Ufuk Celebi (JIRA)" <j...@apache.org>
Subject [jira] [Created] (FLINK-5780) Extend ConfigOption with descriptions
Date Fri, 10 Feb 2017 16:24:41 GMT
Ufuk Celebi created FLINK-5780:

             Summary: 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: 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

>From the ML discussion, these could be:
void shortDescription(String);
void longDescription(String);

In practice, the description string should contain HTML/Markdown.

This message was sent by Atlassian JIRA

View raw message