[
https://issues.apache.org/jira/browse/LUCENE-9890?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17310218#comment-17310218
]
Adrien Grand commented on LUCENE-9890:
--------------------------------------
Maybe the name is confusing, but I like that Lucene is signaling classes that
have an unstable API that might change in minors, which is something that is
not always correlated with how long an API has been available? On the other
hand, the {{@since}} tag says nothing about the stability of an API?
I wonder that "experimental" might be confusing because experimental features
are expected to become non-experimental at some point, so maybe we should call
these APIs "unstable" or something like that instead?
> Retire @lucene.experimental tag and enforce @since tag for public classes
> -------------------------------------------------------------------------
>
> Key: LUCENE-9890
> URL: https://issues.apache.org/jira/browse/LUCENE-9890
> Project: Lucene - Core
> Issue Type: Improvement
> Components: general/javadocs
> Reporter: Tomoko Uchida
> Priority: Minor
>
> We have 800+ {{@lucene.experimental}} annotations in the main branch. Many of
> those classes were created years ago and have been time-tested on various
> setups, so may be able to be cleaned up.
> {code:java}
> lucene $ git grep lucene.experimental | wc -l
> 804
> {code}
> BTW, do we really need this annotation...?
> The description of it says nothing about when we should remove it from the
> javadocs: "lucene.experimental:a:WARNING: This API is experimental and might
> change in incompatible ways in the next release."
>
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
