Experimental SPI annotation #13302
Experimental SPI annotation #13302
Conversation
|
BTW, I'm not sure if we want to mart PFTs as experimental, but I added that commit as a demonstration of how this can work. |
| /** | ||
| * When the community believes the SPI will be finalized, but this date may be extended. | ||
| */ | ||
| String until(); |
There was a problem hiding this comment.
I'm not sure this is a good idea. Who's going to be responsible to keep track of it? It will be quite confusing having a bunch of spis where this is in the past.
There was a problem hiding this comment.
I'd like to have a slack bot that annoys us when Experimental is expiring.
There was a problem hiding this comment.
How about creating a GitHub issue for this and adding a specific label to them?
| @@ -21,6 +22,7 @@ | |||
|
|
|||
| import static java.util.Objects.requireNonNull; | |||
|
|
|||
| @Experimental(until = "2022-10-31") | |||
There was a problem hiding this comment.
Any reason why this particular date? or is this just an example?
also, would it be good to have a link to a ticket describing the work stream that given experimental API belongs to?
There was a problem hiding this comment.
This is just and example... I figured 3 months was plenty of time to finish up any work on the initial SPI.
As for issue, can you propose something specific?
| /** | ||
| * When the community believes the SPI will be finalized, but this date may be extended. | ||
| */ | ||
| String until(); |
There was a problem hiding this comment.
If the annotation is stll present but we're past the until date, it's still experimental.
A thing is experimental until the annotation is removed.
Can we name this parameter to indicate that?
There was a problem hiding this comment.
Can you propose a better name?
The Experimental annotation designates part of the SPI that is still under development and is considered experimental. Experimental SPIs may be changed at any time and maybe removed. The date in the annotation signifies when the community believes the SPI will be finalized, but this date may be extended.
|
I think it'd be good to mention this in docs, filed #13520 and I'll make sure it gets taken care of. |
Description
Add Experimental annotation to SPI
The Experimental annotation designates part of the SPI that is still
under development and is considered experimental. Experimental SPIs may
be changed at any time and maybe removed. The date in the annotation
signifies when the community believes the SPI will be finalized, but
this date may be extended.
Documentation
I'm not sure about documentation. Maybe we should add this to the developer section?
( ) No documentation is needed.
( ) Sufficient documentation is included in this PR.
( ) Documentation PR is available with #prnumber.
( ) Documentation issue #issuenumber is filed, and can be handled later.
Release notes
( ) No release notes entries required.
(X) Release notes entries required with the following suggested text: