lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Mark Miller (JIRA)" <j...@apache.org>
Subject [jira] Issue Comment Edited: (LUCENE-1900) Confusing Javadoc in Searchable.java
Date Tue, 08 Sep 2009 19:01:58 GMT

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

Mark Miller edited comment on LUCENE-1900 at 9/8/09 12:00 PM:
--------------------------------------------------------------

Good point. I've jumped sides.

bq. I'd vote for adding the "expert" tag to IndexReader.maxDoc() before stripping it from
those.

+1

*edit

Actually - as I look over IndexReader, I think its just that the context changes - what is
expert in Searchable is not necessarily expert in IndexReader - moving to that level already
has more advanced implications, and current labeling of expert is slanted to whats more difficult
in reference of IndexReader - its all expert compared to use Searchable.

I think that argues for just leaving as is (the current patch).

      was (Author: markrmiller@gmail.com):
    Good point. I've jumped sides.

bq. I'd vote for adding the "expert" tag to IndexReader.maxDoc() before stripping it from
those.

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


Mime
View raw message