Login | Register For Free | Help
Search for: (Advanced)

Mailing List Archive: Lucene: Java-Dev

[jira] Commented: (LUCENE-2080) Improve the documentation of Version

 

 

Lucene java-dev RSS feed   Index | Next | Previous | View Threaded


jira at apache

Feb 7, 2010, 12:01 PM

Post #1 of 4 (436 views)
Permalink
[jira] Commented: (LUCENE-2080) Improve the documentation of Version

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

Simon Willnauer commented on LUCENE-2080:
-----------------------------------------


I like this extension and I think it is important! Yet, I would use the following wording instead:

{quote}Additionally, you may need to re-test your entire application to ensure it behaves like expected, as some defaults may have changed and may break functionality in your application.{quote}


> Improve the documentation of Version
> ------------------------------------
>
> Key: LUCENE-2080
> URL: https://issues.apache.org/jira/browse/LUCENE-2080
> 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, LUCENE-2080.patch, 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: java-dev-unsubscribe [at] lucene
For additional commands, e-mail: java-dev-help [at] lucene


jira at apache

Feb 7, 2010, 5:15 PM

Post #2 of 4 (420 views)
Permalink
[jira] Commented: (LUCENE-2080) Improve the documentation of Version [In reply to]

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

Michael McCandless commented on LUCENE-2080:
--------------------------------------------

I like the new scary javadoc Robert! I think removing (deprecating today) LUCENE_CURRENT may make sense -- it's very dangerous.

> Improve the documentation of Version
> ------------------------------------
>
> Key: LUCENE-2080
> URL: https://issues.apache.org/jira/browse/LUCENE-2080
> 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, LUCENE-2080.patch, 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: java-dev-unsubscribe [at] lucene
For additional commands, e-mail: java-dev-help [at] lucene


jira at apache

Feb 7, 2010, 5:35 PM

Post #3 of 4 (420 views)
Permalink
[jira] Commented: (LUCENE-2080) Improve the documentation of Version [In reply to]

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

Robert Muir commented on LUCENE-2080:
-------------------------------------

I was thinking... this wording could be more concise too. I will add simons suggestion, trying to also think of the scariest, shortest verbage we can use.

> Improve the documentation of Version
> ------------------------------------
>
> Key: LUCENE-2080
> URL: https://issues.apache.org/jira/browse/LUCENE-2080
> 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, LUCENE-2080.patch, 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: java-dev-unsubscribe [at] lucene
For additional commands, e-mail: java-dev-help [at] lucene


jira at apache

Feb 12, 2010, 3:10 AM

Post #4 of 4 (344 views)
Permalink
[jira] Commented: (LUCENE-2080) Improve the documentation of Version [In reply to]

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

Uwe Schindler commented on LUCENE-2080:
---------------------------------------

We should add a note in CHANGES.txt in 3.0 and 2.9 branch as this is an API change.

Something like: "Deprecated Version.LUCENE_CURRENT constant..." with the reason phrases from above

> Improve the documentation of Version
> ------------------------------------
>
> Key: LUCENE-2080
> URL: https://issues.apache.org/jira/browse/LUCENE-2080
> 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, LUCENE-2080.patch, LUCENE-2080.patch, 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: java-dev-unsubscribe [at] lucene
For additional commands, e-mail: java-dev-help [at] lucene

Lucene java-dev RSS feed   Index | Next | Previous | View Threaded
 
 


Interested in having your list archived? Contact Gossamer Threads
 
  Web Applications & Managed Hosting Powered by Gossamer Threads Inc.