Created: (LUCENE-807) Minor improvement to JavaDoc for ScoreDocComparator

classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|

Created: (LUCENE-807) Minor improvement to JavaDoc for ScoreDocComparator

JIRA jira@apache.org
Minor improvement to JavaDoc for ScoreDocComparator
---------------------------------------------------

                 Key: LUCENE-807
                 URL: https://issues.apache.org/jira/browse/LUCENE-807
             Project: Lucene - Java
          Issue Type: Improvement
          Components: Javadocs
    Affects Versions: 2.1
            Reporter: Paul Cowan
            Priority: Trivial


About to attach a very small patch for ScoreDocComparator which broadens the contract of compare(ScoreDoc, ScoreDoc) to follow the same semantics as java.util.Comparator.compare() -- allow any integer to be returned, rather than specifically -1/0/-1.

Note that this behaviour must already be acceptable; the anonymous ScoreDocComparators returned by FieldSortedHitQueue.comparatorStringLocale() already return the result of Collator.compare(), which is not tied to this -1/0/1 restriction.

--
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: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

Updated: (LUCENE-807) Minor improvement to JavaDoc for ScoreDocComparator

JIRA jira@apache.org

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

Paul Cowan updated LUCENE-807:
------------------------------

    Attachment: ScoreDocComparator.patch

Amends javadoc.


> Minor improvement to JavaDoc for ScoreDocComparator
> ---------------------------------------------------
>
>                 Key: LUCENE-807
>                 URL: https://issues.apache.org/jira/browse/LUCENE-807
>             Project: Lucene - Java
>          Issue Type: Improvement
>          Components: Javadocs
>    Affects Versions: 2.1
>            Reporter: Paul Cowan
>            Priority: Trivial
>         Attachments: ScoreDocComparator.patch
>
>
> About to attach a very small patch for ScoreDocComparator which broadens the contract of compare(ScoreDoc, ScoreDoc) to follow the same semantics as java.util.Comparator.compare() -- allow any integer to be returned, rather than specifically -1/0/-1.
> Note that this behaviour must already be acceptable; the anonymous ScoreDocComparators returned by FieldSortedHitQueue.comparatorStringLocale() already return the result of Collator.compare(), which is not tied to this -1/0/1 restriction.

--
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: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

Resolved: (LUCENE-807) Minor improvement to JavaDoc for ScoreDocComparator

JIRA jira@apache.org
In reply to this post by JIRA jira@apache.org

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

Michael Busch resolved LUCENE-807.
----------------------------------

       Resolution: Fixed
    Fix Version/s: 2.2
    Lucene Fields: [New, Patch Available]  (was: [Patch Available, New])

Committed. Thank you, Paul!

> Minor improvement to JavaDoc for ScoreDocComparator
> ---------------------------------------------------
>
>                 Key: LUCENE-807
>                 URL: https://issues.apache.org/jira/browse/LUCENE-807
>             Project: Lucene - Java
>          Issue Type: Improvement
>          Components: Javadocs
>    Affects Versions: 2.1
>            Reporter: Paul Cowan
>            Priority: Trivial
>             Fix For: 2.2
>
>         Attachments: ScoreDocComparator.patch
>
>
> About to attach a very small patch for ScoreDocComparator which broadens the contract of compare(ScoreDoc, ScoreDoc) to follow the same semantics as java.util.Comparator.compare() -- allow any integer to be returned, rather than specifically -1/0/-1.
> Note that this behaviour must already be acceptable; the anonymous ScoreDocComparators returned by FieldSortedHitQueue.comparatorStringLocale() already return the result of Collator.compare(), which is not tied to this -1/0/1 restriction.

--
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: [hidden email]
For additional commands, e-mail: [hidden email]