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

ASF GitHub Bot commented on FLINK-5781:
---------------------------------------

Github user zentol commented on the issue:

    https://github.com/apache/flink/pull/3495
  
    I would use the class name, as otherwise we add an additional source of 
mistakes. When introducing the `ConfigGroups` annotation the first time; if the 
configured default name doesn't match the class name the docs will break if not 
adjusted properly.
    
    In my mind when you want to extract some options into a separate table for 
the docs you should only have to worry about exactly that, and not about 
breaking the docs for the rest of the class.


> Generation HTML from ConfigOption
> ---------------------------------
>
>                 Key: FLINK-5781
>                 URL: https://issues.apache.org/jira/browse/FLINK-5781
>             Project: Flink
>          Issue Type: Sub-task
>          Components: Documentation
>            Reporter: Ufuk Celebi
>            Assignee: Dawid Wysakowicz
>
> Use the ConfigOption instances to generate a HTML page that we can use to 
> include in the docs configuration page.



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

Reply via email to