Update ruff examples to use the module hook

diff --git a/alembic/templates/async/alembic.ini.mako b/alembic/templates/async/alembic.ini.mako
index 782524e219ff29fcc12c514df77aa14d524563a9..67acc6d05426f6b03b8c650ff79c70ab2216b1b1 100644 (file)
--- a/alembic/templates/async/alembic.ini.mako
+++ b/alembic/templates/async/alembic.ini.mako
@@ -98,10 +98,16 @@ sqlalchemy.url = driver://user:pass@localhost/dbname
 # black.entrypoint = black
 # black.options = -l 79 REVISION_SCRIPT_FILENAME
 
-# lint with attempts to fix using "ruff" - use the exec runner, execute a binary
+# lint with attempts to fix using "ruff" - use the module runner, against the "ruff" module
+# hooks = ruff
+# ruff.type = module
+# ruff.module = ruff
+# ruff.options = check --fix REVISION_SCRIPT_FILENAME
+
+# Alternatively, use the exec runner to execute a binary found on your PATH
 # hooks = ruff
 # ruff.type = exec
-# ruff.executable = %(here)s/.venv/bin/ruff
+# ruff.executable = ruff
 # ruff.options = check --fix REVISION_SCRIPT_FILENAME
 
 # Logging configuration.  This is also consumed by the user-maintained

diff --git a/alembic/templates/generic/alembic.ini.mako b/alembic/templates/generic/alembic.ini.mako
index cb4e2bf399b50d3141e7d6ea4b026a3274c203b7..bb93d0e3cf17447b5aa78da5e1d54ba4d966bae6 100644 (file)
--- a/alembic/templates/generic/alembic.ini.mako
+++ b/alembic/templates/generic/alembic.ini.mako
@@ -98,10 +98,16 @@ sqlalchemy.url = driver://user:pass@localhost/dbname
 # black.entrypoint = black
 # black.options = -l 79 REVISION_SCRIPT_FILENAME
 
-# lint with attempts to fix using "ruff" - use the exec runner, execute a binary
+# lint with attempts to fix using "ruff" - use the module runner, against the "ruff" module
+# hooks = ruff
+# ruff.type = module
+# ruff.module = ruff
+# ruff.options = check --fix REVISION_SCRIPT_FILENAME
+
+# Alternatively, use the exec runner to execute a binary found on your PATH
 # hooks = ruff
 # ruff.type = exec
-# ruff.executable = %(here)s/.venv/bin/ruff
+# ruff.executable = ruff
 # ruff.options = check --fix REVISION_SCRIPT_FILENAME
 
 # Logging configuration.  This is also consumed by the user-maintained

diff --git a/alembic/templates/multidb/alembic.ini.mako b/alembic/templates/multidb/alembic.ini.mako
index 2680ef68a5c444103d0d90ccd2549365af8f630a..a6629839552197a124088e8e46a011446b5165ee 100644 (file)
--- a/alembic/templates/multidb/alembic.ini.mako
+++ b/alembic/templates/multidb/alembic.ini.mako
@@ -106,10 +106,16 @@ sqlalchemy.url = driver://user:pass@localhost/dbname2
 # black.entrypoint = black
 # black.options = -l 79 REVISION_SCRIPT_FILENAME
 
-# lint with attempts to fix using "ruff" - use the exec runner, execute a binary
+# lint with attempts to fix using "ruff" - use the module runner, against the "ruff" module
+# hooks = ruff
+# ruff.type = module
+# ruff.module = ruff
+# ruff.options = check --fix REVISION_SCRIPT_FILENAME
+
+# Alternatively, use the exec runner to execute a binary found on your PATH
 # hooks = ruff
 # ruff.type = exec
-# ruff.executable = %(here)s/.venv/bin/ruff
+# ruff.executable = ruff
 # ruff.options = check --fix REVISION_SCRIPT_FILENAME
 
 # Logging configuration.  This is also consumed by the user-maintained

diff --git a/docs/build/tutorial.rst b/docs/build/tutorial.rst
index 7354c82f501af866f6db052807ed5a57c3b6cedc..eccf8f304b0661b410d62d1103feb5ed9c6e16a6 100644 (file)
--- a/docs/build/tutorial.rst
+++ b/docs/build/tutorial.rst
@@ -248,10 +248,16 @@ The all-in-one .ini file created by ``generic`` is illustrated below::
     # black.entrypoint = black
     # black.options = -l 79 REVISION_SCRIPT_FILENAME
 
-    # lint with attempts to fix using "ruff" - use the exec runner, execute a binary
+    # lint with attempts to fix using "ruff" - use the module runner, against the "ruff" module
+    # hooks = ruff
+    # ruff.type = module
+    # ruff.module = ruff
+    # ruff.options = check --fix REVISION_SCRIPT_FILENAME
+
+    # Alternatively, use the exec runner to execute a binary found on your PATH
     # hooks = ruff
     # ruff.type = exec
-    # ruff.executable = %(here)s/.venv/bin/ruff
+    # ruff.executable = ruff
     # ruff.options = check --fix REVISION_SCRIPT_FILENAME
 
     # Logging configuration.  This is also consumed by the user-maintained