You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2018/04/05 10:47:00 UTC
[jira] [Commented] (FLINK-8742) Move ConfigDocsGenerator annotation
to flink-annotations
[ https://issues.apache.org/jira/browse/FLINK-8742?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16426739#comment-16426739 ]
ASF GitHub Bot commented on FLINK-8742:
---------------------------------------
GitHub user zentol opened a pull request:
https://github.com/apache/flink/pull/5821
[FLINK-8742][docs] Move docs generator annotations to flink-annotations
## What is the purpose of the change
This PR moves the docs generator annotations to flink-docs, for consolidation purposes.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/zentol/flink 8742
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/flink/pull/5821.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 #5821
----
commit 4c6527430ca5d3ac9f9c1a18cdcc403b3f47f93e
Author: zentol <ch...@...>
Date: 2018-04-05T10:17:27Z
[FLINK-8742][docs] Move docs generator annotations to flink-annotations
----
> Move ConfigDocsGenerator annotation to flink-annotations
> --------------------------------------------------------
>
> Key: FLINK-8742
> URL: https://issues.apache.org/jira/browse/FLINK-8742
> Project: Flink
> Issue Type: Improvement
> Components: Configuration
> Affects Versions: 1.5.0
> Reporter: Chesnay Schepler
> Assignee: Tuo Wang
> Priority: Trivial
> Labels: easy-fix, starter
> Fix For: 1.5.0
>
>
> The {{ConfigDocsGenerator}} added annotations to modify the behavior of the generator output. ({{ConfigGroup}} and {{ConfigGroups}}).
> Currently these annotations are part of {{flink-core}} and residein the same package as the various `ConfigOption` classes.
> I propose moving them to flink-annotations for consolidation. We may also place them in a new module in {{flink-docs}}, but given that we already have a module exclusively for annotations this seems overkill.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)