lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Jason Gerlowski <gerlowsk...@gmail.com>
Subject Re: Proposal: create @since Javadoc tags for URPs, Analyzers
Date Mon, 09 Oct 2017 18:10:01 GMT
+1 to @since tags.

And an extra +1 to start adding the version to new @deprecated tags.
And maybe even to do some digging in git so the version can be added
to things that are already deprecated.  I ran into this exact issue a
few times in the last months.

On Mon, Oct 9, 2017 at 12:04 PM, Shawn Heisey <apache@elyograg.org> wrote:
> On 10/3/2017 10:11 AM, Alexandre Rafalovitch wrote:
>> I am thinking of adding Javadoc @since tags to the classes. Primarily
>> to the components Solr end-users would configure with (Analyzers,
>> URPs), but could theoretically do it for many more over time.
>
> +1, I like it.  I also like the idea of adding this tag on ALL new
> classes/methods.  As existing code is modified, they could be gradually
> added to those as well, if the correct version can be determined.  I
> would want to avoid massive commits adding a large number of tags at
> once that cause a lot of merge conflicts.
>
> On a tangent, I think that @deprecated tags should include the version
> where the deprecation happened.  Sometimes I think that deprecated code
> is sticking around longer than it should because nobody is completely
> sure when it happened.
>
> Like others responding here, I think that javadocs in general,
> particularly in Solr, could use more care and attention.  Are there any
> best practices written down for Lucene javadocs that could be helpful
> for Solr as well?
>
> Thanks,
> Shawn
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
> For additional commands, e-mail: dev-help@lucene.apache.org
>

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


Mime
View raw message