You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by zentol <gi...@git.apache.org> on 2018/04/05 10:51:51 UTC
[GitHub] flink pull request #5822: [FLINK-8743][docs] Allow overriding documented def...
GitHub user zentol opened a pull request:
https://github.com/apache/flink/pull/5822
[FLINK-8743][docs] Allow overriding documented default
Based on #5821.
## What is the purpose of the change
This PR adds an annotation to override the documented default.
## Verifying this change
This change added tests and can be verified as follows:
* `ConfigOptionsDocGeneratorTest#testOverrideDefault`
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/zentol/flink 8743
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/flink/pull/5822.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #5822
----
commit 4c6527430ca5d3ac9f9c1a18cdcc403b3f47f93e
Author: zentol <ch...@...>
Date: 2018-04-05T10:17:27Z
[FLINK-8742][docs] Move docs generator annotations to flink-annotations
commit 10064482cc0d0e2dbddfc4d3988c4a17f78700fa
Author: zentol <ch...@...>
Date: 2018-04-05T10:42:42Z
[FLINK-8743][docs] Allow overriding documented default
----
---
[GitHub] flink pull request #5822: [FLINK-8743][docs] Allow overriding documented def...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/flink/pull/5822
---
[GitHub] flink issue #5822: [FLINK-8743][docs] Allow overriding documented default
Posted by aljoscha <gi...@git.apache.org>.
Github user aljoscha commented on the issue:
https://github.com/apache/flink/pull/5822
Ok, makes sense to merge then.
---
[GitHub] flink issue #5822: [FLINK-8743][docs] Allow overriding documented default
Posted by zentol <gi...@git.apache.org>.
Github user zentol commented on the issue:
https://github.com/apache/flink/pull/5822
Annotations have a number of advantages:
* they don't pollute the `ConfigOption` class with documentation concerns
* we don't have to define reasonable defaults to prevent issues at runtime
* we can add/remove annotations at any time as they aren't `@Public`
---
[GitHub] flink issue #5822: [FLINK-8743][docs] Allow overriding documented default
Posted by zentol <gi...@git.apache.org>.
Github user zentol commented on the issue:
https://github.com/apache/flink/pull/5822
merging.
---