[Xapian-tickets] [Xapian] #697: Omega SORTREVERSE semantics confusing

[Xapian]

#697: Omega SORTREVERSE semantics confusing
--------------------+--------------------------
 Reporter:  olly    |             Owner:  olly
     Type:  defect  |            Status:  new
 Priority:  normal  |         Milestone:  1.3.x
Component:  Omega   |           Version:  1.3.3
 Severity:  normal  |        Resolution:
 Keywords:          |        Blocked By:
 Blocking:          |  Operating System:  All
--------------------+--------------------------
Description changed by olly:

Old description:

> This is analogous to the changes made to the xapian-core API in 1.0.11 as
> a result of #311.
>
> Currently Omega default to `reverse=true` (in current xapian-core terms),
> and `SORTREVERSE=1` sets `reverse=false`.  Argh.
>
> The only sane way out I can see is to deprecate `SORTREVERSE` and add a
> new CGI parameter to specify forwards or reverse searching, which is
> documented as something that should always be specified if `SORT` is
> specified.  Then in the release series after 1.4.x, we can remove
> `SORTREVERSE`, change the default if neither `SORTREVERSE` nor the new
> parameter is specified to `reverse=false`, and all is well.
>
> Not sure what a good name for the new parameter is though.
>
> Marking for 1.3.x, as this doesn't need much work at all (once we have a
> parameter name!) and would make sense to do before the 1.4 release
> series.
> (Issue actually noted by Andy Chilton).

New description:

 This is analogous to the changes made to the xapian-core API in 1.0.11 as
 a result of #311.

 Currently Omega default to `reverse=true` (in current xapian-core terms),
 and `SORTREVERSE=1` sets `reverse=false`.  Argh.

 The only sane way out I can see is to deprecate `SORTREVERSE` and add a
 new CGI parameter to specify forwards or reverse searching, which is
 documented as something that should always be specified if `SORT` is
 specified.  Then in the release series after 1.4.x, we can remove
 `SORTREVERSE`, change the default if neither `SORTREVERSE` nor the new
 parameter is specified to `reverse=false`, and all is well.

 Not sure what a good name for the new parameter is though.

 Marking for 1.3.x, as this doesn't need much work at all (once we have a
 parameter name!) and would make sense to do before the 1.4 release series.

 (Issue actually noted by Andy Chilton).

--

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