From 8c29bd343930fb6bf4e42761bcb4ddf1c59971ee Mon Sep 17 00:00:00 2001
From: Kuchenpirat <24235032+Kuchenpirat@users.noreply.github.com>
Date: Tue, 23 Jul 2024 17:43:21 +0200
Subject: [PATCH] fix: task py:migrate description (#3932)
---
Taskfile.yml | 2 +-
docs/docs/contributors/developers-guide/database-changes.md | 2 +-
docs/docs/overrides/api.html | 2 +-
3 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/Taskfile.yml b/Taskfile.yml
index ca939af4c9b..22ce80da153 100644
--- a/Taskfile.yml
+++ b/Taskfile.yml
@@ -148,7 +148,7 @@ tasks:
- poetry run python mealie/app.py
py:migrate:
- desc: generates a new database migration file e.g. task py:migrate "add new column"
+ desc: generates a new database migration file e.g. task py:migrate -- "add new column"
cmds:
- poetry run alembic revision --autogenerate -m "{{ .CLI_ARGS }}"
- task: py:format
diff --git a/docs/docs/contributors/developers-guide/database-changes.md b/docs/docs/contributors/developers-guide/database-changes.md
index 9e4f8f4a145..cd51c55162c 100644
--- a/docs/docs/contributors/developers-guide/database-changes.md
+++ b/docs/docs/contributors/developers-guide/database-changes.md
@@ -9,7 +9,7 @@ How exactly you need to modify it is of course highly contextual to the change y
## Using Alembic to generate upgrade script
-In your dev container you can run something like (change the message) `task py:migrate "Add creation tag to group preferences"` to have Alembic generate an upgrade script for you.
+In your dev container you can run something like (change the message) `task py:migrate -- "Add creation tag to group preferences"` to have Alembic generate an upgrade script for you.
The script Alembic generates, will be limited! (Perhaps there's a way to resolve that? Haven't looked into it yet)
For example, Alembic generated a script _similar_ to this (it has been modified already to have accurate foreign key names, for instance):
diff --git a/docs/docs/overrides/api.html b/docs/docs/overrides/api.html
index 2f8571381f7..334025e5eea 100644
--- a/docs/docs/overrides/api.html
+++ b/docs/docs/overrides/api.html
@@ -14,7 +14,7 @@