Re: Bogus documentation for bogus geometric operators - Mailing list pgsql-hackers

From Pavel Borisov
Subject Re: Bogus documentation for bogus geometric operators
Date
Msg-id CALT9ZEELPyV6yMbLV-c-B8z2MAJTEkW4f-qxxVUKnAZCoaz1bw@mail.gmail.com
Whole thread Raw
In response to Re: Bogus documentation for bogus geometric operators  (Tom Lane <tgl@sss.pgh.pa.us>)
Responses Re: Bogus documentation for bogus geometric operators  (Tom Lane <tgl@sss.pgh.pa.us>)
List pgsql-hackers
1. The patch removes <^ and >^ from func.sgml, which is fine, but 
shouldn't there be an addition for the new operators?  (I think
I fully agree and added "point" as a possible input type for <<| and |>> in manual. PFA v5
 
undocumented.  Maybe instead of removing, change the text to be
"Deprecated, use the equivalent XXX operator instead."  Or we could
add a footnote similar to what was there for a previous renaming:
The problem that this new <<| is equivalent to <^ only for points (To recap: the source of a problem is the same name of <^  operator for points and boxes with different meaning for these types). 

                               point                                                                                       box
<<| |>>          strictly above/below  (new)                                                strictly above/below 
<^ >^             strictly above/below (deprecated, but available)               above/below

So it seems to me that trying to mention the subtle difference of deprecated operator to same-named one for different data type inevitably make things much worse for reader. On this reason I'd vote for complete nuking <^ for point type (but this is not the only way so I haven't done this in v5).

What do you think?

--
Best regards,
Pavel Borisov

Postgres Professional: http://postgrespro.com
Attachment

pgsql-hackers by date:

Previous
From: Kyotaro Horiguchi
Date:
Subject: Re: In-placre persistance change of a relation
Next
From: Amit Kapila
Date:
Subject: Re: Parallel copy