lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Robert Muir (JIRA)" <>
Subject [jira] Reopened: (LUCENE-2080) Improve the documentation of Version
Date Sun, 07 Feb 2010 19:16:27 GMT


Robert Muir reopened LUCENE-2080:

It seems that LUCENE_CURRENT is still causing some confusion.

I am reopening this issue and propose removing this constant entirely.

Regardless of whether we want to remove it, it should be @deprecated, have much scarier javadocs
text, and instead positive wording like 'latest and greatest' should instead be applied to
LUCENE_31 (whatever the latest constant is), to encourage users to use that instead.

> Improve the documentation of Version
> ------------------------------------
>                 Key: LUCENE-2080
>                 URL:
>             Project: Lucene - Java
>          Issue Type: Task
>          Components: Javadocs
>            Reporter: Robert Muir
>            Assignee: Robert Muir
>            Priority: Trivial
>             Fix For: 2.9.2, 3.0, 3.1
>         Attachments: LUCENE-2080.patch
> In my opinion, we should elaborate more on the effects of changing the Version parameter.
> Particularly, changing this value, even if you recompile your code, likely involves reindexing
your data.
> I do not think this is adequately clear from the current javadocs.

This message is automatically generated by JIRA.
You can reply to this email to add a comment to the issue online.

To unsubscribe, e-mail:
For additional commands, e-mail:

View raw message