From 45650053d522fdb2ea263b92177a6daace0172cf Mon Sep 17 00:00:00 2001 From: Karl Hobley Date: Wed, 9 Dec 2020 16:29:41 +0000 Subject: [PATCH] Avoid recommending replacing image/document models entirely (#6624) ... when using the ``WAGTAILIMAGES_IMAGE_MODEL``/``WAGTAILDOCS_DOCUMENT_MODEL`` settings. We can't really support this as we add new fields and methods to these base classes which all images/documents must support. If we did want to support swapping out the models entirely, every addition we make to the base models could be a breaking change. --- docs/reference/settings.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/reference/settings.rst b/docs/reference/settings.rst index 66b53a3d18..67bdbdb900 100644 --- a/docs/reference/settings.rst +++ b/docs/reference/settings.rst @@ -207,7 +207,7 @@ Images WAGTAILIMAGES_IMAGE_MODEL = 'myapp.MyImage' -This setting lets you provide your own image model for use in Wagtail, which might extend the built-in ``AbstractImage`` class or replace it entirely. +This setting lets you provide your own image model for use in Wagtail, which should extend the built-in ``AbstractImage`` class. .. code-block:: python @@ -261,7 +261,7 @@ Documents WAGTAILDOCS_DOCUMENT_MODEL = 'myapp.MyDocument' -This setting lets you provide your own document model for use in Wagtail, which might extend the built-in ``AbstractDocument`` class or replace it entirely. +This setting lets you provide your own document model for use in Wagtail, which should extend the built-in ``AbstractDocument`` class. .. code-block:: python