[ https://issues.apache.org/jira/browse/FLINK-30862?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17683001#comment-17683001 ]
Dawid Wysakowicz edited comment on FLINK-30862 at 2/1/23 12:36 PM: ------------------------------------------------------------------- I second [~chesnay]. I don't think we should document deprecated options as they should not be used. Listing deprecated options gives an impression it can still be used. was (Author: dawidwys): I second [~chesnay]. I don't think we should document deprecated options as they should not be used. If an option is subsumed by a newer one, it should be listed in the description of a newer option and thus be searchable. Listing deprecated options gives an impression it can still be used. > Config doc generation should keep @deprecated ConfigOption > ---------------------------------------------------------- > > Key: FLINK-30862 > URL: https://issues.apache.org/jira/browse/FLINK-30862 > Project: Flink > Issue Type: Improvement > Reporter: Jing Ge > Assignee: Jing Ge > Priority: Major > > Currently the content will be removed once the ConfigOption is marked as > @deprecated. The content should be kept and marked with a deprecated flag, > since the ConfigOption is only deprecated and still be used. The content > should be only removed when the ConfigOption has been removed. > > If we just remove the fresh deprecated option in the document, user will be > confused and think the option is gone and does not work anymore, which means > the backward compatibility is broken. > -- This message was sent by Atlassian Jira (v8.20.10#820010)