summaryrefslogtreecommitdiff
path: root/docs/build/tutorial.rst
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2013-11-26 14:08:46 -0500
committerMike Bayer <mike_mp@zzzcomputing.com>2013-11-26 14:08:46 -0500
commitf8d9f9ecc73f03edc16a6c7327b275db7c769222 (patch)
tree46cb2c755d60a412ece22d8b5601c845db7c86d6 /docs/build/tutorial.rst
parent39e4b4a97a8cf5668ca89a278bf716eeb503eea9 (diff)
downloadalembic-f8d9f9ecc73f03edc16a6c7327b275db7c769222.tar.gz
- make slug length default to 40, but also make it configurable.
Diffstat (limited to 'docs/build/tutorial.rst')
-rw-r--r--docs/build/tutorial.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/build/tutorial.rst b/docs/build/tutorial.rst
index 97cb285..7da4292 100644
--- a/docs/build/tutorial.rst
+++ b/docs/build/tutorial.rst
@@ -119,6 +119,10 @@ The file generated with the "generic" configuration looks like::
# template used to generate migration files
# file_template = %%(rev)s_%%(slug)s
+ # max length of characters to apply to the
+ # "slug" field
+ #truncate_slug_length = 40
+
# set to 'true' to run the environment during
# the 'revision' command, regardless of autogenerate
# revision_environment = false
@@ -196,6 +200,11 @@ This file contains the following features:
.. versionadded:: 0.3.6 - added date parameters to ``file_template``.
+* ``truncate_slug_length`` - defaults to 40, the max number of characters
+ to include in the "slug" field.
+
+ .. versionadded:: 0.6.1 - added ``truncate_slug_length`` configuration
+
* ``sqlalchemy.url`` - A URL to connect to the database via SQLAlchemy. This key is in fact
only referenced within the ``env.py`` file that is specific to the "generic" configuration;
a file that can be customized by the developer. A multiple