pvary commented on PR #23865: URL: https://github.com/apache/flink/pull/23865#issuecomment-1840787769
I would suggest to change the [previous](https://nightlies.apache.org/flink/flink-docs-master/docs/ops/upgrading/#api-compatibility-guarantees) paragraph, like the following (remove the API compatibility related parts from there): The top part could remain the same, just the title changed to `Compatibility guarantees`: ``` Compatibility guarantees The classes & members of the Java/Scala APIs that are intended for users are annotated with the following stability annotations: - Public - PublicEvolving - Experimental Annotations on a class also apply to all members of that class, unless otherwise annotated. Any API without such an annotation is considered internal to Flink, with no guarantees being provided. ``` Then we should create 2 sub-paragraphs. The 1st one could be `Binary compatibility`: ``` We guarantee binary compatibility only between patch releases for Public, and PublicEvolving interfaces. Example: Code written against Public and PublicEvolving interfaces in 1.15.2 will continue to run in 1.15.3, without having to recompile the code. That same code would have to be recompiled when upgrading to 1.16.0 though, even if no code change is required based on the API compatibility guarantees. ``` The 2nd one could be `API compatibility`, and here could come the paragraph written by @becketqin -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
