You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by "Zhanghao Chen (Jira)" <ji...@apache.org> on 2024/02/05 06:46:00 UTC
[jira] [Commented] (FLINK-33240) Generate docs for deprecated options as well
[ https://issues.apache.org/jira/browse/FLINK-33240?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17814182#comment-17814182 ]
Zhanghao Chen commented on FLINK-33240:
---------------------------------------
Closing it for duplication. The effort is postponed due to objections.
> Generate docs for deprecated options as well
> --------------------------------------------
>
> Key: FLINK-33240
> URL: https://issues.apache.org/jira/browse/FLINK-33240
> Project: Flink
> Issue Type: Improvement
> Components: Documentation
> Reporter: Zhanghao Chen
> Priority: Major
> Fix For: 1.19.0
>
>
> Currently, Flink will skip doc generation for deprecated options (SeeĀ
> {{{}ConfigOptionsDocGenerator#{}}}{{{}shouldBeDocumented{}}}). As a result, the deprecated options can no longer be found in the new version of Flink document. This might confuse users upgrading from an older version of Flink and they have to either carefully read the release notes or check the source code for upgrading guidance on deprecated options. I suggest generating doc for deprecated options as well, and we should scan through the code to make sure that proper upgrading guidance is provided for the deprecated options.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)