Merge pull request #2156 from stevepiercy/feature/alchemy-scaffold-update

add comment to NAMING_CONVENTION per 9b12c01168cb756ec36351d7414cad95e87f6581

6 files changed, 21 insertions, 6 deletions

diff --git a/docs/tutorials/wiki2/basiclayout.rst b/docs/tutorials/wiki2/basiclayout.rst
index 1426e55a5..e3d0a0a3c 100644
--- a/docs/tutorials/wiki2/basiclayout.rst
+++ b/docs/tutorials/wiki2/basiclayout.rst
@@ -211,8 +211,8 @@ will inherit from the ``Base`` class so they can be associated with our
 particular database connection.
 
    .. literalinclude:: src/basiclayout/tutorial/models/meta.py
-      :lines: 15-16
-      :lineno-start: 15
+      :lines: 18-19
+      :lineno-start: 18
       :linenos:
       :language: py
 
@@ -221,7 +221,7 @@ configures various database settings by calling subsequently defined functions.
 
    .. literalinclude:: src/basiclayout/tutorial/models/meta.py
       :pyobject: includeme
-      :lineno-start: 19
+      :lineno-start: 22
       :linenos:
       :language: py
 
@@ -232,7 +232,7 @@ unless an exception is raised, in which case the transaction will be aborted.
 
    .. literalinclude:: src/basiclayout/tutorial/models/meta.py
       :pyobject: get_session
-      :lineno-start: 32
+      :lineno-start: 35
       :linenos:
       :language: py
 
@@ -243,7 +243,7 @@ URI, something like ``sqlite://``.
 
    .. literalinclude:: src/basiclayout/tutorial/models/meta.py
       :pyobject: get_engine
-      :lineno-start: 39
+      :lineno-start: 42
       :linenos:
       :language: py
 
@@ -254,7 +254,7 @@ creating a session with the database engine.
 
    .. literalinclude:: src/basiclayout/tutorial/models/meta.py
       :pyobject: get_dbmaker
-      :lineno-start: 43
+      :lineno-start: 46
       :linenos:
       :language: py
 
diff --git a/docs/tutorials/wiki2/src/authorization/tutorial/models/meta.py b/docs/tutorials/wiki2/src/authorization/tutorial/models/meta.py
index b72b45f9f..80ececd8c 100644
--- a/docs/tutorials/wiki2/src/authorization/tutorial/models/meta.py
+++ b/docs/tutorials/wiki2/src/authorization/tutorial/models/meta.py
@@ -4,6 +4,9 @@ from sqlalchemy.orm import sessionmaker
 from sqlalchemy.schema import MetaData
 import zope.sqlalchemy
 
+# Recommended naming convention used by Alembic, as various different database
+# providers will autogenerate vastly different names making migrations more
+# difficult. See: http://alembic.readthedocs.org/en/latest/naming.html
 NAMING_CONVENTION = {
     "ix": 'ix_%(column_0_label)s',
     "uq": "uq_%(table_name)s_%(column_0_name)s",
diff --git a/docs/tutorials/wiki2/src/basiclayout/tutorial/models/meta.py b/docs/tutorials/wiki2/src/basiclayout/tutorial/models/meta.py
index b72b45f9f..80ececd8c 100644
--- a/docs/tutorials/wiki2/src/basiclayout/tutorial/models/meta.py
+++ b/docs/tutorials/wiki2/src/basiclayout/tutorial/models/meta.py
@@ -4,6 +4,9 @@ from sqlalchemy.orm import sessionmaker
 from sqlalchemy.schema import MetaData
 import zope.sqlalchemy
 
+# Recommended naming convention used by Alembic, as various different database
+# providers will autogenerate vastly different names making migrations more
+# difficult. See: http://alembic.readthedocs.org/en/latest/naming.html
 NAMING_CONVENTION = {
     "ix": 'ix_%(column_0_label)s',
     "uq": "uq_%(table_name)s_%(column_0_name)s",
diff --git a/docs/tutorials/wiki2/src/models/tutorial/models/meta.py b/docs/tutorials/wiki2/src/models/tutorial/models/meta.py
index b72b45f9f..80ececd8c 100644
--- a/docs/tutorials/wiki2/src/models/tutorial/models/meta.py
+++ b/docs/tutorials/wiki2/src/models/tutorial/models/meta.py
@@ -4,6 +4,9 @@ from sqlalchemy.orm import sessionmaker
 from sqlalchemy.schema import MetaData
 import zope.sqlalchemy
 
+# Recommended naming convention used by Alembic, as various different database
+# providers will autogenerate vastly different names making migrations more
+# difficult. See: http://alembic.readthedocs.org/en/latest/naming.html
 NAMING_CONVENTION = {
     "ix": 'ix_%(column_0_label)s',
     "uq": "uq_%(table_name)s_%(column_0_name)s",
diff --git a/docs/tutorials/wiki2/src/tests/tutorial/models/meta.py b/docs/tutorials/wiki2/src/tests/tutorial/models/meta.py
index b72b45f9f..80ececd8c 100644
--- a/docs/tutorials/wiki2/src/tests/tutorial/models/meta.py
+++ b/docs/tutorials/wiki2/src/tests/tutorial/models/meta.py
@@ -4,6 +4,9 @@ from sqlalchemy.orm import sessionmaker
 from sqlalchemy.schema import MetaData
 import zope.sqlalchemy
 
+# Recommended naming convention used by Alembic, as various different database
+# providers will autogenerate vastly different names making migrations more
+# difficult. See: http://alembic.readthedocs.org/en/latest/naming.html
 NAMING_CONVENTION = {
     "ix": 'ix_%(column_0_label)s',
     "uq": "uq_%(table_name)s_%(column_0_name)s",
diff --git a/docs/tutorials/wiki2/src/views/tutorial/models/meta.py b/docs/tutorials/wiki2/src/views/tutorial/models/meta.py
index b72b45f9f..80ececd8c 100644
--- a/docs/tutorials/wiki2/src/views/tutorial/models/meta.py
+++ b/docs/tutorials/wiki2/src/views/tutorial/models/meta.py
@@ -4,6 +4,9 @@ from sqlalchemy.orm import sessionmaker
 from sqlalchemy.schema import MetaData
 import zope.sqlalchemy
 
+# Recommended naming convention used by Alembic, as various different database
+# providers will autogenerate vastly different names making migrations more
+# difficult. See: http://alembic.readthedocs.org/en/latest/naming.html
 NAMING_CONVENTION = {
     "ix": 'ix_%(column_0_label)s',
     "uq": "uq_%(table_name)s_%(column_0_name)s",