You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@lucene.apache.org by "Tomoko Uchida (Jira)" <ji...@apache.org> on 2021/03/28 22:36:00 UTC

[jira] [Resolved] (LUCENE-9890) Retire @lucene.experimental tag and enforce @since tag for public classes

     [ https://issues.apache.org/jira/browse/LUCENE-9890?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Tomoko Uchida resolved LUCENE-9890.
-----------------------------------
    Resolution: Won't Fix

I understand "experimental" and "since" tags are not substitutions for each other if they are properly maintanined.

I just wanted to a bit clear my points:
 * Some people use "experimental" tag and others don't; then what does it mean at all?
 * While "experimental" is just a marker that represents individual author's feeling or confidence and it seems to be remained for good in the codebase, "since" tag could be more reliable indicator that practically shows some flavour of stability or "coreness" of the classes (I understand there are still substantial logical jump though)

For example, SynonymGraphFilter and KoreanTokenizer are marked "experimental" (they don' have "since" tag in the meantime) for years... So many users already heavily rely on them, I think they aren't - and maybe shouldn't be - "experimental" feature.

However I don't intend to proceed this if there are developers who need or want to use "experimental" tag. It may be kind of bikeshed discussion.

> 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: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org