[ 
https://issues.apache.org/jira/browse/LUCENE-1900?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Mark Miller updated LUCENE-1900:
--------------------------------

    Attachment: LUCENE-1900.patch

> Confusing Javadoc in Searchable.java
> ------------------------------------
>
>                 Key: LUCENE-1900
>                 URL: https://issues.apache.org/jira/browse/LUCENE-1900
>             Project: Lucene - Java
>          Issue Type: Bug
>          Components: Search
>    Affects Versions: 2.9
>            Reporter: Nadav Har'El
>            Assignee: Mark Miller
>            Priority: Trivial
>         Attachments: LUCENE-1900.patch
>
>
> In Searchable.java, the javadoc for maxdoc() is:
>   /** Expert: Returns one greater than the largest possible document number.
>    * Called by search code to compute term weights.
>    * @see org.apache.lucene.index.IndexReader#maxDoc()
> The qualification "expert" and the statement "called by search code to 
> compute term weights" is a bit confusing, It implies that maxdoc() somehow 
> computes weights, which is obviously not true (what it does is explained in 
> the other sentence). Maybe it is used as one factor of the weight, but do we 
> really need to mention this here? 

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

Reply via email to