[
https://issues.apache.org/jira/browse/LUCENE-9890?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17311352#comment-17311352
]
Tomoko Uchida edited comment on LUCENE-9890 at 3/30/21, 10:10 AM:
------------------------------------------------------------------
[~gsmiller] thanks for your comments.
We could start from a case-by-case approach - choose some experimental APIs
that look sufficiently stable, and propose to remove their marker to promote
them to officially ( ? ) supported APIs, one by one. The main challenge there
would be, I think, it's hard to give a formal guarantee to any APIs. Lucene is
continuously evolved by volunteer based community without top-down control as
you know, so from my perspective all of our APIs are under experimental status
whether they are explicitly marked as "experimental" or not.
Maybe it's not a binary decision but gradual consensus, I hope we find out some
different approach from explicit labeling to show the stability levels of the
APIs. Introducing labels is easy but finding the rationale to change/remove
them is hard as we see...
was (Author: tomoko uchida):
[~gsmiller] thanks for your comments.
We could start from a case-by-case approach - choose some experimental APIs
that look sufficiently stable, and propose to remove their marker to promote
them to officially ( ? ) supported APIs, one by one. The main challenge there
would be, I think, it's hard to give a formal guarantee to any APIs. Lucene is
continuously evolved by volunteer based community without top-down control as
you know, so from my perspective all of our APIs are under experimental status
whether they are explicitly marked as "experimental" or not.
Maybe it's not a binary decision but gradual consensus, I hope we find out some
different approach from explicit labeling to show the stability levels of the
APIs. Introducing labels is easy but finding the rationale to change/remove
them are hard as we see...
> 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]
