From: Mike Bayer <mike_mp@zzzcomputing.com>
Date: Thu, 28 Apr 2011 16:33:30 +0000 (-0400)
Subject: update docs for generic associations
X-Git-Tag: rel_0_7_0~25
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=46daefe5b09192b1669be4fe48e84faa8d54008c;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git

update docs for generic associations
---

diff --git a/doc/build/orm/examples.rst b/doc/build/orm/examples.rst
index a9bcf56cc7..2314062324 100644
--- a/doc/build/orm/examples.rst
+++ b/doc/build/orm/examples.rst
@@ -57,6 +57,15 @@ Location: /examples/dynamic_dict/
 
 .. automodule:: dynamic_dict
 
+.. _examples_generic_associations:
+
+Generic Associations
+--------------------
+
+Location: /examples/generic_associations
+
+.. automodule:: generic_associations
+
 .. _examples_sharding:
 
 Horizontal Sharding
@@ -90,9 +99,7 @@ Location: /examples/nested_sets/
 Polymorphic Associations
 ------------------------
 
-Location: /examples/poly_assoc/
-
-.. automodule:: poly_assoc
+See :ref:`examples_generic_associations` for a modern version of polymorphic associations.
 
 PostGIS Integration
 -------------------
diff --git a/examples/generic_associations/__init__.py b/examples/generic_associations/__init__.py
index 7e94694fe0..b166d91610 100644
--- a/examples/generic_associations/__init__.py
+++ b/examples/generic_associations/__init__.py
@@ -4,14 +4,21 @@ parents with a particular child object.
 
 The examples all use the declarative extension along with 
 declarative mixins.   Each one presents the identical use
-case at the end - two clases, ``Customer`` and ``Supplier``, both
+case at the end - two classes, ``Customer`` and ``Supplier``, both
 subclassing the ``HasAddresses`` mixin, which ensures that the
 parent class is provided with an ``addresses`` collection
 which contains ``Address`` objects.
 
+The configurations include:
+
+* ``table_per_related.py`` - illustrates a distinct table per related collection.
+* ``table_per_association.py`` - illustrates a shared collection table, using a
+  table per association.
+* ``discriminator_on_association.py`` - shared collection table and shared
+  association table, including a discriminator column.
+
 The ``discriminator_on_association.py`` script in particular is a modernized
 version of the "polymorphic associations" example present in older versions of
-SQLAlchemy.
-
+SQLAlchemy, originally from the blog post at http://techspot.zzzeek.org/2007/05/29/polymorphic-associations-with-sqlalchemy/.
 
 """
\ No newline at end of file