-
Notifications
You must be signed in to change notification settings - Fork 13k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[FLINK-29740][Scala] Mark all Scala APIs as @Deprecated
#21176
[FLINK-29740][Scala] Mark all Scala APIs as @Deprecated
#21176
Conversation
8fcdf71
to
5c8a4af
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this PR goes a bit too far. The purpose of a deprecation is to inform users about an outdated class or method. We don't need to deprecate every little corner of an API we if want to drop the entire API anyway. A blog post, an updated roadmap radar, and moving the API web documentation into a dedicated "Legacy APIs" section should be sufficient. Although we deprecate an API, the API should still be usable in an IDE for some time, which is not the case if all API parts are striked through. If at all, we should only deprecate the entry point of the API.
5c8a4af
to
4739db8
Compare
Following our offline sync on this, I've gone with marking the package (which is what you see if you visit https://nightlies.apache.org/flink/flink-docs-master/api/scala/org/apache/flink/api/scala/index.html) and the ExecutionEnvironment https://nightlies.apache.org/flink/flink-docs-master/api/scala/org/apache/flink/api/scala/ExecutionEnvironment.html as The one thing I'm still doubting a bit is about the Scala documentation examples: should we add a hint warning to all examples (feels like overkill), a generic hint for each page that contains a Scala example or should we remove the Scala examples? |
Does this mean that flink won't support Scala by default? |
See https://cwiki.apache.org/confluence/display/FLINK/FLIP-265+Deprecate+and+remove+Scala+API+support -> There won't be dedicated Scala APIs in Flink anymore, but you can still use Scala to write your Flink applications. That's explained in https://flink.apache.org/2022/02/22/scala-free.html |
I'd remove the Scala examples and add a warning all pages that are specifically about Scala (like https://nightlies.apache.org/flink/flink-docs-release-1.16/docs/dev/datastream/scala_api_extensions/). |
acc64b3
to
f092bc7
Compare
- Remove Scala tests that relied on Scala examples - Remove Scala test from `SocketWindowWordCount` - Remove Scala example testing from CI
… DataStream Overview Page, Table Concepts & Common API page and the DataStream Scala Extensions Page
f092bc7
to
bfbd8c0
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The scala quickstart/walkthrough are still referenced in the documentation.
@flinkbot run azure |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
https://nightlies.apache.org/flink/flink-docs-release-1.16/docs/dev/configuration pages could also use some deprecation notices.
…ache#21176 * [FLINK-29740][Scala] Remove Scala examples, quickstarts and walkthroughs * [FLINK-29740][Scala] Mark Scala package and Scala ExecutionEnvironment as @deprecated * [FLINK-29740][Scala] Remove Scala E2E tests/walkthroughs - Remove Scala tests that relied on Scala examples - Remove Scala test from `SocketWindowWordCount` - Remove Scala example testing from CI * [FLINK-29740][Scala] Add deprecation hint to the documentation on the DataStream Overview Page, Table Concepts & Common API page and the DataStream Scala Extensions Page * [FLINK-29740][Scala] Remove Scala quickstart/walkthrough from documentation * [FLINK-29740][Scala] Add Scala deprecation warning to project configuration overview
…ache#21176 * [FLINK-29740][Scala] Remove Scala examples, quickstarts and walkthroughs * [FLINK-29740][Scala] Mark Scala package and Scala ExecutionEnvironment as @deprecated * [FLINK-29740][Scala] Remove Scala E2E tests/walkthroughs - Remove Scala tests that relied on Scala examples - Remove Scala test from `SocketWindowWordCount` - Remove Scala example testing from CI * [FLINK-29740][Scala] Add deprecation hint to the documentation on the DataStream Overview Page, Table Concepts & Common API page and the DataStream Scala Extensions Page * [FLINK-29740][Scala] Remove Scala quickstart/walkthrough from documentation * [FLINK-29740][Scala] Add Scala deprecation warning to project configuration overview
What is the purpose of the change
Brief change log
@Deprecated
Verifying this change
This change is a trivial rework / code cleanup without any test coverage.
Does this pull request potentially affect one of the following parts:
@Public(Evolving)
: yesDocumentation