lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Michael Osipov (JIRA)" <j...@apache.org>
Subject [jira] [Comment Edited] (LUCENE-4525) JavaDoc of SearcherManager#close is not crystal clear
Date Fri, 02 Nov 2012 13:27:12 GMT

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

Michael Osipov edited comment on LUCENE-4525 at 11/2/12 1:25 PM:
-----------------------------------------------------------------

Why no further releases? Has this published officially on the website? Lucene 4.0 has a completely
new API. There are probably plenty of users who cannot upgrade that easy.

Patch is fine but for two spots:

1. Close this ReferenceManager... => Closes this ReferenceManager... (third person)
2. Applications should not {@link #acquire() acquire} references from.. => Applications
should not {@link #acquire() acquire} new references from... (crystal clear)
                
      was (Author: michael-o):
    Why no further releases? Lucene has a completely new API. There are probably plently of
users who cannot upgrade that easy.

Patch is fine but for two spots:

1. Close this ReferenceManager... => Closes this ReferenceManager... (third person)
2. Applications should not {@link #acquire() acquire} references from.. => Applications
should not {@link #acquire() acquire} new references from... (crystal clear)
                  
> JavaDoc of SearcherManager#close is not crystal clear
> -----------------------------------------------------
>
>                 Key: LUCENE-4525
>                 URL: https://issues.apache.org/jira/browse/LUCENE-4525
>             Project: Lucene - Core
>          Issue Type: Improvement
>          Components: core/search
>    Affects Versions: 3.6.1, 4.0
>            Reporter: Michael Osipov
>            Assignee: Simon Willnauer
>            Priority: Minor
>         Attachments: LUCENE-4525.patch, LUCENE-4525.patch
>
>
> Raised from http://www.mail-archive.com/java-user@lucene.apache.org/msg40064.html
> The JavaDoc says:
> {noformat}
>   /**
>    * Close this ReferenceManager to future {@link #acquire() acquiring}. Any
>    * references that were previously {@link #acquire() acquired} won't be
>    * affected, and they should still be {@link #release released} when they are
>    * not needed anymore.
>    */
> {noformat}
> The first sentence is not really clear. I would expect something like:
> {noformat}
> Close this ReferenceManager when the application is shutting down or the
>  underlying index will be disposed. Any references that were previously
>  {@link #acquire() acquired} won't be affected, and they should still be 
> {@link #release released} when they are not needed anymore.
> {noformat}
> Further more, the JavaDoc does not declare that an exception will be thrown on any method.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

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


Mime
View raw message