lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Mark Miller (JIRA)" <>
Subject [jira] Commented: (LUCENE-1900) Confusing Javadoc in
Date Tue, 08 Sep 2009 17:41:59 GMT


Mark Miller commented on LUCENE-1900:

Thanks Doron - I was going to err on leaving the expert and just stripping:

"Called by search code to compute term weights."

Sounds like your not opposed to that?

> Confusing Javadoc in
> ------------------------------------
>                 Key: LUCENE-1900
>                 URL:
>             Project: Lucene - Java
>          Issue Type: Bug
>          Components: Search
>    Affects Versions: 2.9
>            Reporter: Nadav Har'El
>            Assignee: Mark Miller
>            Priority: Trivial
> In, 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:
For additional commands, e-mail:

View raw message