Refine documentation for `show_in_menus` (#8072)

- this appears to be a point of confusion, where developers are unsure what this field does
- this update makes it more explicit that this field does not do anything, except the queryset usage, by default
pull/7906/head
LB (Ben Johnston) 2022-03-05 00:34:21 +10:00 zatwierdzone przez GitHub
rodzic ef2fa2e394
commit 70aabb5d34
Nie znaleziono w bazie danych klucza dla tego podpisu
ID klucza GPG: 4AEE18F83AFDEB23
1 zmienionych plików z 4 dodań i 2 usunięć

Wyświetl plik

@ -90,9 +90,11 @@ Database fields
(boolean)
Toggles whether the page should be included in site-wide menus.
Toggles whether the page should be included in site-wide menus, and is shown in the ``promote_panels`` within the Page editor.
This is used by the :meth:`~wagtail.core.query.PageQuerySet.in_menu` QuerySet filter.
Wagtail does not include any menu implementation by default, which means that this field will not do anything in the front facing content unless built that way in a specific Wagtail installation.
However, this is used by the :meth:`~wagtail.core.query.PageQuerySet.in_menu` QuerySet filter to make it easier to query for pages that use this field.
Defaults to ``False`` and can be overridden on the model with ``show_in_menus_default = True``.