[ 
https://issues.apache.org/jira/browse/LUCENE-8733?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16798329#comment-16798329
 ] 

Christine Poerschke commented on LUCENE-8733:
---------------------------------------------

{quote}... curious to better understand your motivation?
{quote}
The use case I guess is to be able to 'browse' (probably more likely in IDE 
than via re-generated javadocs) on a 'current' branch of the repo i.e. 
currently branch_8x (or possibly master) and to easily see for the brand-new 
stuff in sandbox if it was already available in the version of the software 
that one is currently running and if not from what version onwards it is 
available. Of course the info would also be available in other ways e.g. 
CHANGES.txt and JIRA tickets but 'with the code' seems quite helpful 
specifically in the sandbox scenario. And I'm _not_ suggesting we move towards 
having "@since" tags all over the place or in an automatically enforced way, 
it's just here specifically with intervals in the sandbox I would find the 
presence of such tags helpful :)

> retrospectively add @since javadocs for 'intervals' classes
> -----------------------------------------------------------
>
>                 Key: LUCENE-8733
>                 URL: https://issues.apache.org/jira/browse/LUCENE-8733
>             Project: Lucene - Core
>          Issue Type: Wish
>            Reporter: Christine Poerschke
>            Assignee: Christine Poerschke
>            Priority: Minor
>         Attachments: LUCENE-8733-branch-7-4.patch
>
>
> LUCENE-8196 started 'intervals' and subsequent tickets extended it.
> This ticket proposes to retrospectively add {{@since X.Y}} javadocs for all 
> the classes (and to then going forward perhaps continue to add them).
> And perhaps we could have an 'intervals' or similar JIRA components choice 
> too?



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org
For additional commands, e-mail: dev-h...@lucene.apache.org

Reply via email to