From 1247565d3da6b542f97b59d7fd62c8c7c624f6b8 Mon Sep 17 00:00:00 2001 From: Martey Dodoo Date: Fri, 10 Aug 2018 11:54:58 -0400 Subject: [PATCH] Add warning about unregistering image formats. Add warning to documentation to warn that unregistering image formats that are being used will create an error when viewing or editing pages. See https://groups.google.com/forum/#!topic/wagtail/X8xTUs-2npA and https://github.com/wagtail/wagtail/issues/1471#issuecomment-118436706. --- docs/advanced_topics/customisation/page_editing_interface.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/advanced_topics/customisation/page_editing_interface.rst b/docs/advanced_topics/customisation/page_editing_interface.rst index 8b223d197..9d3d5eb1b 100644 --- a/docs/advanced_topics/customisation/page_editing_interface.rst +++ b/docs/advanced_topics/customisation/page_editing_interface.rst @@ -143,6 +143,9 @@ To begin, import the ``Format`` class, ``register_image_format`` function, and o To unregister, call ``unregister_image_format`` with the string of the ``name`` of the ``Format`` as the only argument. + .. warning:: + Unregistering ``Format`` objects will cause errors viewing or editing pages that reference them. + .. _custom_edit_handler_forms: Customising generated forms