[ 
https://issues.apache.org/jira/browse/FLINK-30862?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Jing Ge updated FLINK-30862:
----------------------------
    Description: 
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, user will be confused and think 
the option is gone and does not work anymore, which means the backward 
compatibility is broken.

 

  was:
Currently the content will be removed once the ConfigOption is marked as 
@deprecated. It should be kept, since the ConfigOption is only deprecated and 
still be used. The content should be only removed when the ConfigOption has 
been removed.

 


> 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, 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)

Reply via email to