From 5e26d9a910137b7b4c24f82f9914d40e284523c9 Mon Sep 17 00:00:00 2001 From: David-Wobrock Date: Sun, 8 Nov 2020 18:11:32 +0100 Subject: [PATCH] Document the incompatibility codes --- docs/incompatibilities.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/incompatibilities.md b/docs/incompatibilities.md index 5df319b..0dd0ad1 100644 --- a/docs/incompatibilities.md +++ b/docs/incompatibilities.md @@ -19,3 +19,20 @@ We are happy to add more if you can specify them to us. On data migrations, the linter will show a warning when: * you are missing a reverse migration * the RunPython arguments do not respect the naming convention `apps, schema_editor` + +## Codes + +You can ignore check through the `--exclude-migration-test` option and specifying any of the codes: + +| Code | Description | +|-----------------------------------|----------------------------------------------------------------------| +|`NOT_NULL` | Not NULL constraint on columns +|`DROP_COLUMN` | Dropping columns +|`DROP_TABLE` | Dropping tables +|`RENAME_COLUMN` | Renaming columns +|`RENAME_TABLE` | Renaming tables +|`ALTER_COLUMN` | Altering columns (could be backward compatible) +|`ADD_UNIQUE` | Add unique constraints +|`REVERSIBLE_DATA_MIGRATION` | RunPython data migration is not reversible (missing reverse code) +|`NAMING_CONVENTION_RUNPYTHON_ARGS` | By convention, RunPython names two arguments: apps, schema_editor +|`DATA_MIGRATION_MODEL_IMPORT` | Missing apps.get_model() calls for model