You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by "Nadav Har'El (JIRA)" <ji...@apache.org> on 2009/09/08 17:08:57 UTC
[jira] Created: (LUCENE-1900) Confusing Javadoc in Searchable.java
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
Priority: Trivial
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
[jira] Commented: (LUCENE-1900) Confusing Javadoc in
Searchable.java
Posted by "Marvin Humphrey (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-1900?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12752612#action_12752612 ]
Marvin Humphrey commented on LUCENE-1900:
-----------------------------------------
maxDoc() isn't just used for calculating weights. It's also used for e.g.
figuring out how big your bit vector needs to be in order to accommodate the
largest doc in the collection.
My vote would be to just strip that extra comment about calculating term
weights.
> 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
> Priority: Trivial
>
> 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
[jira] Commented: (LUCENE-1900) Confusing Javadoc in
Searchable.java
Posted by "Doron Cohen (JIRA)" <ji...@apache.org>.
[ 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: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org
[jira] Commented: (LUCENE-1900) Confusing Javadoc in
Searchable.java
Posted by "Mark Miller (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-1900?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12752618#action_12752618 ]
Mark Miller commented on LUCENE-1900:
-------------------------------------
bq. My vote would be to just strip that extra comment about calculating term weights.
+1 - unless someone else comments, I'm just going to do that.
> 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
> Priority: Trivial
>
> 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
[jira] Commented: (LUCENE-1900) Confusing Javadoc in
Searchable.java
Posted by "Doron Cohen (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-1900?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12752637#action_12752637 ]
Doron Cohen commented on LUCENE-1900:
-------------------------------------
{quote}
stripping: "Called by search code to compute term weights."
Sounds like your not opposed to that?
{quote}
Yes, I agree, go ahead...
While looking at this though, how about other "Expert" and "called by" javadoc comments in this class? - like the one in doc(int i) - I am not sure what's so expert about it..? Also there are 3 more 'called by' javadoc comments in that class, are they really needed?
> 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
>
> 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
[jira] Commented: (LUCENE-1900) Confusing Javadoc in
Searchable.java
Posted by "Marvin Humphrey (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-1900?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12752675#action_12752675 ]
Marvin Humphrey commented on LUCENE-1900:
-----------------------------------------
IMO, maxDoc(), docFreq(), and docFreqs() are all expert, because they all
require an understanding of the deletions mechanism to grasp their behavior.
I'd vote for adding the "expert" tag to IndexReader.maxDoc() before stripping
it from those.
> 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
[jira] Issue Comment Edited: (LUCENE-1900) Confusing Javadoc in
Searchable.java
Posted by "Mark Miller (JIRA)" <ji...@apache.org>.
[ 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
[jira] Updated: (LUCENE-1900) Confusing Javadoc in Searchable.java
Posted by "Mark Miller (JIRA)" <ji...@apache.org>.
[ 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-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org
[jira] Commented: (LUCENE-1900) Confusing Javadoc in
Searchable.java
Posted by "Mark Miller (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-1900?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12752676#action_12752676 ]
Mark Miller commented on LUCENE-1900:
-------------------------------------
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
[jira] Commented: (LUCENE-1900) Confusing Javadoc in
Searchable.java
Posted by "Doron Cohen (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-1900?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12752625#action_12752625 ]
Doron Cohen commented on LUCENE-1900:
-------------------------------------
hi.., I think the 'expert' is here because it reveals internal information which users should not rely on unless understanding exactly what they are doing with it. - well, at least as internal as are the unstable docids - on the other hand, IndexReader.maxDoc() is not marked 'expert', so perhaps this one also should not be marked 'expert'.
Similarity.idfExplain(Term,Searcher) explains nicely why maxDoc() is used rather than numDocs():
{noformat}
* Note that {@link Searcher#maxDoc()} is used instead of
* {@link org.apache.lucene.index.IndexReader#numDocs()} because it is
* proportional to {@link Searcher#docFreq(Term)} , i.e., when one is
* inaccurate, so is the other, and in the same direction.
{noformat}
> 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
>
> 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
[jira] Commented: (LUCENE-1900) Confusing Javadoc in
Searchable.java
Posted by "Mark Miller (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-1900?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12752657#action_12752657 ]
Mark Miller commented on LUCENE-1900:
-------------------------------------
I figured I'd leave em -
but I do agree that it makes more sense to pull the expert from them. Will add to the patch.
If it doesn't belong on docFreq, it doesn't belong on docFreqs (which was just added to reduce chatter over RMI it appears by the comment)
> 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
[jira] Commented: (LUCENE-1900) Confusing Javadoc in
Searchable.java
Posted by "Mark Miller (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-1900?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12752627#action_12752627 ]
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 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
>
> 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
[jira] Commented: (LUCENE-1900) Confusing Javadoc in
Searchable.java
Posted by "Mark Miller (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-1900?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12752573#action_12752573 ]
Mark Miller commented on LUCENE-1900:
-------------------------------------
Yeah - could be more clear.
I agree that there doesn't appear to be a need to mark it as expert. And I guess we should just remove the part that mentions its involved in the weight? Or re word.
"This is used as an approximation of the number of documents in the index for scoring calculations."
Or something to that effect (namely, better). Perhaps approximation isnt even needed -
"Because un-merged deleted docs still contribute to index statistics, this is used as the number of documents in the index for scoring calculations."
or ...
> 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
> Priority: Trivial
>
> 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
[jira] Resolved: (LUCENE-1900) Confusing Javadoc in Searchable.java
Posted by "Mark Miller (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-1900?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Mark Miller resolved LUCENE-1900.
---------------------------------
Resolution: Fixed
Lucene Fields: [New, Patch Available] (was: [New])
thanks all
> 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
[jira] Commented: (LUCENE-1900) Confusing Javadoc in
Searchable.java
Posted by "Mark Miller (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-1900?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12752640#action_12752640 ]
Mark Miller commented on LUCENE-1900:
-------------------------------------
Good point - we should remove that expert and the called by's - one of them references a deprecated class (HitCollector), so it def needs to be changed in either case.
I'll make a quick 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
>
> 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
[jira] Commented: (LUCENE-1900) Confusing Javadoc in
Searchable.java
Posted by "Doron Cohen (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-1900?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12752687#action_12752687 ]
Doron Cohen commented on LUCENE-1900:
-------------------------------------
{quote}
what is expert in Searchable is not necessarily expert in IndexReader - moving to that level already has more advanced implications
{quote}
I agree (even though IndexReader is not marked 'expert').
{quote}
I think that argues for just leaving as is (the current patch).
{quote}
+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
[jira] Updated: (LUCENE-1900) Confusing Javadoc in Searchable.java
Posted by "Mark Miller (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-1900?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Mark Miller updated LUCENE-1900:
--------------------------------
Fix Version/s: 2.9
> 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
[jira] Assigned: (LUCENE-1900) Confusing Javadoc in Searchable.java
Posted by "Mark Miller (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-1900?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Mark Miller reassigned LUCENE-1900:
-----------------------------------
Assignee: Mark Miller
> 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
>
> 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