From: mike bayer <mike_mp@zzzcomputing.com>
Date: Wed, 26 Jun 2013 15:15:44 +0000 (-0700)
Subject: Merge pull request #12 from cjw296/master
X-Git-Tag: rel_0_8_2~31
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=23805f50ed71d314c3f576210c329175f781c7d5;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git

Merge pull request #12 from cjw296/master

Range type docs improvements.
---

diff --git a/doc/build/dialects/postgresql.rst b/doc/build/dialects/postgresql.rst
index f2b401e9a5..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
 ---------------------------
@@ -116,10 +132,7 @@ SQLAlchemy supports Postgresql EXCLUDE constraints via the
 
 For example::
 
-  from sqlalchemy.dialects.postgresql import (
-      ExcludeConstraint,
-      TSRANGE as Range,
-      )
+  from sqlalchemy.dialects.postgresql import ExcludeConstraint, TSRANGE
 
   class RoomBookings(Base):