[Kernel] Add @Evolving and @since tags to all the Kernel API interfaces
#2041
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
scottsand-db
approved these changes
Sep 12, 2023
| @@ -48,7 +49,10 @@ | |||
|
|
|||
| /** | |||
| * Represents a scan of a Delta table. | |||
| * | |||
| * @since 3.0.0 | |||
There was a problem hiding this comment.
Sorry, this wasn't totally clear to me in your PR description.
Why is this a comment? * @since 3.0.0 instead of an annotation like @Evolving below?
There was a problem hiding this comment.
@since is a tag supported by javadoc and evolving is not.
… class/method docs, if no docs are present on the implementation.
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which Delta project/connector is this regarding?
Description
Kernel APIs are in the development phase. Add tags to indicate the APIs are evolving to set the expectations for API users.
Also, add a
@sincetag to indicate which version the API interface/method was introduced in. This is not done for the Kernel APIs in this PR. In the future, Kernel API docs can adopt the same.The
Delta-Sparkmodule does extra labeling of evolving APIs by modifying the generated APIHow was this patch tested?
NA