[jira] [Commented] (FLINK-8743) Add annotation to override documented default

["ASF GitHub Bot (JIRA)" <ji...@apache.org>]

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

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

Github user zentol commented on the issue:

    https://github.com/apache/flink/pull/5822
  
    merging.


> Add annotation to override documented default
> ---------------------------------------------
>
>                 Key: FLINK-8743
>                 URL: https://issues.apache.org/jira/browse/FLINK-8743
>             Project: Flink
>          Issue Type: New Feature
>          Components: Configuration, Documentation
>            Reporter: Chesnay Schepler
>            Assignee: Chesnay Schepler
>            Priority: Trivial
>             Fix For: 1.5.0
>
>
> The default value for some {{ConfigOptions}} is difficult to document as it isn't static. This mostly affects options that use {{System.getProperty("java.io.tmpdir")}}, as for example {{CoreOptions#TMP_DIRS}}.
> To deal with this the generator has a special branch for selected options that overrides this default: 
> {code}
> if (option == WebOptions.TMP_DIR || option.key().equals("python.dc.tmp.dir") || option == CoreOptions.TMP_DIRS) {
> 	defaultValue = null;
> }
> {code}
> (let's ignore for now that it just wipes the default and isn't setting it to "System.getProperty("java.io.tmpdir")")
> This is pretty much hidden deep in the implementation of the generator. It would be better if we had a dedicated annotation {{@OverrideDocumentedDefault(String override)}} that options could be annotated with.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)