From: Mike Bayer <mike_mp@zzzcomputing.com>
Date: Wed, 17 Jun 2015 18:54:34 +0000 (-0400)
Subject: - add clarification that this tutorial is against the generic template
X-Git-Tag: rel_0_7_7~5
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a3f181a7a05ad6dac23d221af9ae08641d128c2d;p=thirdparty%2Fsqlalchemy%2Falembic.git

- add clarification that this tutorial is against the generic template
---

diff --git a/docs/build/autogenerate.rst b/docs/build/autogenerate.rst
index 12790da3..549aeec4 100644
--- a/docs/build/autogenerate.rst
+++ b/docs/build/autogenerate.rst
@@ -13,7 +13,8 @@ has a `declarative base <http://www.sqlalchemy.org/docs/orm/extensions/declarati
 in ``myapp.mymodel``.  This base contains a :class:`~sqlalchemy.schema.MetaData` object which
 contains :class:`~sqlalchemy.schema.Table` objects defining our database.  We make sure this
 is loaded in ``env.py`` and then passed to :meth:`.EnvironmentContext.configure` via the
-``target_metadata`` argument.   The ``env.py`` sample script already has a
+``target_metadata`` argument.   The ``env.py`` sample script used in the
+generic template already has a
 variable declaration near the top for our convenience, where we replace ``None``
 with our :class:`~sqlalchemy.schema.MetaData`.  Starting with::
 
@@ -28,6 +29,14 @@ we change to::
     from myapp.mymodel import Base
     target_metadata = Base.metadata
 
+.. note::
+
+  The above example refers to the **generic alembic env.py template**, e.g.
+  the one created by default when calling upon ``alembic init``, and not
+  the special-use templates such as ``multidb``.   Please consult the source
+  code and comments within the ``env.py`` script directly for specific
+  guidance on where and how the autogenerate metadata is established.
+
 If we look later in the script, down in ``run_migrations_online()``,
 we can see the directive passed to :meth:`.EnvironmentContext.configure`::