docs

1 files changed, 12 insertions, 0 deletions

diff --git a/alembic/script.py b/alembic/script.py
index 9784d68..a8ac9a0 100644
--- a/alembic/script.py
+++ b/alembic/script.py
@@ -99,6 +99,18 @@ class ScriptDirectory(object):
             ]
 
     def run_env(self):
+        """Run the script environment.
+        
+        This basically runs the ``env.py`` script present
+        in the migration environment.   It is called exclusively
+        by the command functions in :mod:`alembic.command`.
+        
+        As ``env.py`` runs :func:`.context.configure_connection`, 
+        the connection environment should be set up first.   This
+        is typically achieved using the :func:`.context.opts`.
+        
+        
+        """
         util.load_python_file(self.dir, 'env.py')
 
     @util.memoized_property