[
https://issues.apache.org/jira/browse/LUCENE-1900?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12752653#action_12752653
]
Doron Cohen commented on LUCENE-1900:
-------------------------------------
Mark, thanks for removing the 'called by's
After applying the patch there are still a few 'expert' statements:
* maxDoc() - I think you wanted to remove this one?
* docFreq() - it is not marked expert in IndexReader... should it be marked so
here?
* docFeqs() - not sure here
There are 3 more 'expert' sttmnts which seem okay to me.
> 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
> Fix For: 2.9
>
> 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: [email protected]
For additional commands, e-mail: [email protected]