Clarify how script_location can be os agnostic

Fixes: #1431 Change-Id: Iafe70621911614d197e5e5ecf74afecd6f4df10e
sqlalchemy · Mar 18, 2024 · b6e7e2f · b6e7e2f
1 parent 55038e6
commit b6e7e2f
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 7 deletions.
diff --git a/alembic/templates/async/alembic.ini.mako b/alembic/templates/async/alembic.ini.mako
@@ -1,7 +1,8 @@
 # A generic, single database configuration.
 
 [alembic]
-# path to migration scripts
+# path to migration scripts.
+# Use forward slashes (/) also on windows to provide an os agnostic path
 script_location = ${script_location}
 
 # template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
@@ -20,8 +21,7 @@ prepend_sys_path = .
 # leave blank for localtime
 # timezone =
 
-# max length of characters to apply to the
-# "slug" field
+# max length of characters to apply to the "slug" field
 # truncate_slug_length = 40
 
 # set to 'true' to run the environment during

diff --git a/alembic/templates/generic/alembic.ini.mako b/alembic/templates/generic/alembic.ini.mako
@@ -2,6 +2,7 @@
 
 [alembic]
 # path to migration scripts
+# Use forward slashes (/) also on windows to provide an os agnostic path
 script_location = ${script_location}
 
 # template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
@@ -22,8 +23,7 @@ prepend_sys_path = .
 # leave blank for localtime
 # timezone =
 
-# max length of characters to apply to the
-# "slug" field
+# max length of characters to apply to the "slug" field
 # truncate_slug_length = 40
 
 # set to 'true' to run the environment during

diff --git a/alembic/templates/multidb/alembic.ini.mako b/alembic/templates/multidb/alembic.ini.mako
@@ -2,6 +2,7 @@
 
 [alembic]
 # path to migration scripts
+# Use forward slashes (/) also on windows to provide an os agnostic path
 script_location = ${script_location}
 
 # template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
@@ -22,8 +23,7 @@ prepend_sys_path = .
 # leave blank for localtime
 # timezone =
 
-# max length of characters to apply to the
-# "slug" field
+# max length of characters to apply to the "slug" field
 # truncate_slug_length = 40
 
 # set to 'true' to run the environment during