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 16:41:00 UTC
[jira] [Comment Edited] (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:comment-tabpanel&focusedCommentId=17310232#comment-17310232 ]
Tomoko Uchida edited comment on LUCENE-9890 at 3/28/21, 4:40 PM:
-----------------------------------------------------------------
Renaming it to "unstable" could make sense. Meanwhile, the question I'd like to pose here is - there are too many "experimental" (or "unstable") APIs; we do not have any clear policy about which APIs should be remained in experimental or unstable status as far as I know (it's completely up to the author's sense), and once a class is marked "experimental" it seem to be remain experimental feature for good. I do not see any difference between experimental APIs and non-experimental (unmarked) ones... do we need to distinguish experimental/unstable APIs from others, in other words, are there developers who really care about this tag when making API changes?
was (Author: tomoko uchida):
Renaming it to "unstable" could make sense. Meanwhile, the question I'd like to pose here is - there are too many "experimental" (or "unstable") APIs; we do not have any clear policy about which APIs should be remained in experimental or unstable status (it's completely up to the author's sense), and once a class is marked "experimental" it seem to be remain experimental feature for long. I do not see any difference between experimental APIs and non-experimental (unmarked) ones...
> 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