[
https://issues.apache.org/jira/browse/FLINK-32560?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17746431#comment-17746431
]
Ryan Skraba commented on FLINK-32560:
-------------------------------------
Hello -- I tend to agree that the PR is over-annotated! This was a bit of
fastidious work to make sure that we met "the Letter of the Law" for
deprecating every exposed API. This case is slightly different because we're
dropping the entire module (as opposed to _guiding_ the developer from one
method or class to another). I think the intention is pretty well met by
deprecating the entrypoints.
Adding the class-level annotations for 1.18 could be the compromise, especially
because the Scala API is less maintained and tested we can expect it to degrade
over time, but I have no objection to just closing the PR.
Taking this into account, I propose:
* We consider the current state (the entrypoints already deprecated) to be
sufficient for removing the Scala API in 2.0, and this PR is just to give some
*extra* heads up to developers.
* Avoid deprecating methods, only classes, regardless of explicit visibility
annotations on annotations.
* Prefer the {{@scala.deprecated}} annotation on Scala code, but don't worry
too much about it. My common tooling (IntelliJ) treats them as the same. As a
scala dev, I prefer the scala annotation on scala code. Scaladoc notes both,
but puts the scala annotation in a separate "Deprecated" section.
Regardless, spotless breaks up the link to the FLIP-265 and it's not rendered
correctly in scaladoc APIs. This is an easy fix.
If we agree on this, I can update the PR, or we can leave it all as it is!
> Properly deprecate all Scala APIs
> ---------------------------------
>
> Key: FLINK-32560
> URL: https://issues.apache.org/jira/browse/FLINK-32560
> Project: Flink
> Issue Type: Sub-task
> Components: API / Scala
> Reporter: Xintong Song
> Assignee: Ryan Skraba
> Priority: Blocker
> Labels: pull-request-available
> Fix For: 1.18.0
>
>
> We agreed to drop Scala API support in FLIP-265 [1], and have tried to
> deprecate them in FLINK-29740. Also, both user documentation and roadmap[2]
> shows that scala API supports are deprecated. However, none of the APIs in
> `flink-streaming-scala` are annotated with `@Deprecated` atm, and only
> `ExecutionEnvironment` and `package` are marked `@Deprecated` in
> `flink-scala`.
> [1]
> https://cwiki.apache.org/confluence/display/FLINK/FLIP-265+Deprecate+and+remove+Scala+API+support
> [2] https://flink.apache.org/roadmap/
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
