From: Chris Withers <chris@simplistix.co.uk>
Date: Wed, 26 Jun 2013 06:29:48 +0000 (+0100)
Subject: Tidy range types docs and add warning about the return type support offered by differ... 
X-Git-Tag: rel_0_9_0b1~228^2
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=fb469dfb240ef62ee05d58f843f4923c635a6ad2;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git

Tidy range types docs and add warning about the return type support offered by different versions of different DBAPI libraries.
---

diff --git a/doc/build/dialects/postgresql.rst b/doc/build/dialects/postgresql.rst
index d401eef5b9..3c151483f9 100644
--- a/doc/build/dialects/postgresql.rst
+++ b/doc/build/dialects/postgresql.rst
@@ -82,8 +82,11 @@ construction arguments, are as follows:
     :members: __init__
     :show-inheritance:
 
-.. autoclass:: sqlalchemy.dialects.postgresql.ranges.RangeOperators
-    :members:
+Range Types
+~~~~~~~~~~~
+
+The new range column types founds in PostgreSQL 9.2 onwards are
+catered for by the following types:
 
 .. autoclass:: INT4RANGE
    :show-inheritance:
@@ -103,6 +106,19 @@ construction arguments, are as follows:
 .. autoclass:: TSTZRANGE
    :show-inheritance:
 
+The types above get most of their functionality from the following
+mixin:
+
+.. autoclass:: sqlalchemy.dialects.postgresql.ranges.RangeOperators
+    :members:
+
+.. warning::
+
+  The range type DDL support should work with any Postgres DBAPI
+  driver, however the data types returned may vary. If you are using
+  ``psycopg2``, it's recommended to upgrade to version 2.5 or later
+  before using these column types.
+
 
 PostgreSQL Constraint Types
 ---------------------------