[jira] Commented: (LUCENE-1113) fix for Document.getBoost() documentation

["Doron Cohen (JIRA)" <ji...@apache.org>]

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

Doron Cohen commented on LUCENE-1113:
-------------------------------------

How about:
{noformat}
   Returns, at indexing time, the boost factor as set by {@link #setBoost(float)}. 

   <p>Note that once a document is indexed this value is no longer available
   from the index.  At search time, for retrieved documents, this method always 
   returns 1. This however does not mean that the boost value set at  indexing 
   time was ignored - it was just combined with other indexing time factors and 
   stored elsewhere, for better indexing and search performance. (For more 
   info see the "norm(t,d)" part of the scoring formula in 
   {@link org.apache.lucene.search.Similarity Similarity}.
{noformat}

> fix for Document.getBoost() documentation
> -----------------------------------------
>
>                 Key: LUCENE-1113
>                 URL: https://issues.apache.org/jira/browse/LUCENE-1113
>             Project: Lucene - Java
>          Issue Type: Bug
>          Components: Javadocs
>    Affects Versions: 2.2
>            Reporter: Daniel Naber
>            Priority: Minor
>         Attachments: document-getboost.diff
>
>
> The attached patch fixes the javadoc to make clear that getBoost() will never return a useful value in most cases. I will commit this unless someone has a better wording or a real fix.

-- 
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@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org