[Xapian-tickets] [Xapian] #311: set_sort_by_value has incorrect sense for 'ascending'

[Xapian]

#311: set_sort_by_value has incorrect sense for 'ascending'
---------------------------+------------------------------------------------
 Reporter:  tommortimer    |        Owner:  olly    
     Type:  defect         |       Status:  new     
 Priority:  normal         |    Milestone:  1.1.0   
Component:  Documentation  |      Version:  SVN HEAD
 Severity:  minor          |   Resolution:          
 Keywords:                 |    Blockedby:          
 Platform:  All            |     Blocking:          
---------------------------+------------------------------------------------
Changes (by richard):

  * milestone:  => 1.1.0


Comment:

 Perhaps the easiest documentation fix would be to change the parameter
 name from "ascending" to "descending", and to change the parameter
 documentation from:

 {{{
 ascending       If true, documents values which sort higher by string
 compare are better. If false, the sort order is reversed. (default true)
 }}}

 to

 {{{
 descending      If true, documents will be returned such that those with
 values which sort higher by string compare are returned with higher rank
 (so, as the result set is iterated in forward order, the value will
 descend).  If false, the sort order is reversed. (default true)
 }}}

 Note that currently, the meaning of "ascending" used by
 Xapian::Enquire::set_docid_order is that as the mset is iterated in
 forward order, the docid increases.  This is the opposite meaning to that
 used by set_sort_by_value() (and related methods), so resolving this
 inconsistency would be good.

-- 
Ticket URL: <http://trac.xapian.org/ticket/311#comment:2>
Xapian <http://xapian.org/>
Xapian