From f0d3edfad6c0a998a172b7c71e1a9168d6bda6d0 Mon Sep 17 00:00:00 2001 From: helloshiv Date: Tue, 12 Nov 2024 22:04:21 +0530 Subject: [PATCH] Fix wagtailcache and wagtailpagecache examples to not use quotes for the fragment_name --- CHANGELOG.txt | 2 ++ docs/releases/6.3.1.md | 1 + docs/releases/6.4.md | 1 + docs/topics/writing_templates.md | 6 +++--- 4 files changed, 7 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.txt b/CHANGELOG.txt index ad978f8afe..14de6ab3ee 100644 --- a/CHANGELOG.txt +++ b/CHANGELOG.txt @@ -36,6 +36,7 @@ Changelog * Docs: Document usage of custom validation for admin form pages when using `AbstractEmailForm` or `AbstractForm` pages (John-Scott Atlakson, LB (Ben) Johnston) * Docs: Reword `BlogTagIndexPage` example for clarity (Clifford Gama) * Docs: Change title of blog index page in tutorial to avoid slug issues (Thibaud Colas) + * Docs: Fix `wagtailcache` and `wagtailpagecache` examples to not use quotes for the `fragment_name` (Shiv) * Maintenance: Close open files when reading within utils/setup.py (Ataf Fazledin Ahamed) * Maintenance: Avoid redundant `ALLOWED_HOSTS` check in `Site.find_for_request` (Jake Howard) * Maintenance: Update `CloneController` to ensure that `added`/`cleared` events are not dispatched as cancelable (LB (Ben) Johnston) @@ -58,6 +59,7 @@ Changelog * Fix: Improve spacing of page / collection permissions table in Group settings (Sage Abdullah) * Docs: Reword `BlogTagIndexPage` example for clarity (Clifford Gama) * Docs: Change title of blog index page in tutorial to avoid slug issues (Thibaud Colas) + * Docs: Fix `wagtailcache` and `wagtailpagecache` examples to not use quotes for the `fragment_name` (Shiv) 6.3 LTS (01.11.2024) diff --git a/docs/releases/6.3.1.md b/docs/releases/6.3.1.md index 42ce9b5b21..7acfd8e025 100644 --- a/docs/releases/6.3.1.md +++ b/docs/releases/6.3.1.md @@ -23,3 +23,4 @@ depth: 1 * Reword `BlogTagIndexPage` example for clarity and several other tweaks (Clifford Gama) * Change title of blog index page in tutorial to avoid slug issues (Thibaud Colas) + * Fix `wagtailcache` and `wagtailpagecache` examples to not use quotes for the `fragment_name` (Shiv) diff --git a/docs/releases/6.4.md b/docs/releases/6.4.md index dcfd80d85f..69bf3398d7 100644 --- a/docs/releases/6.4.md +++ b/docs/releases/6.4.md @@ -52,6 +52,7 @@ depth: 1 * Document usage of [Custom validation for admin form pages](form_builder_custom_admin_validation) when using `AbstractEmailForm` or `AbstractForm` pages (John-Scott Atlakson, LB (Ben) Johnston) * Reword `BlogTagIndexPage` example for clarity (Clifford Gama) * Change title of blog index page in tutorial to avoid slug issues (Thibaud Colas) + * Fix `wagtailcache` and `wagtailpagecache` examples to not use quotes for the `fragment_name` (Shiv) ### Maintenance diff --git a/docs/topics/writing_templates.md b/docs/topics/writing_templates.md index b30f6cb4bf..70b9488c17 100644 --- a/docs/topics/writing_templates.md +++ b/docs/topics/writing_templates.md @@ -342,7 +342,7 @@ The `{% wagtailcache %}` tag functions similarly to Django's `{% cache %}` tag, ```html+django {% load wagtail_cache %} -{% wagtailcache 500 "sidebar" %} +{% wagtailcache 500 sidebar %} {% endwagtailcache %} ``` @@ -358,7 +358,7 @@ Much like `{% cache %}`, you can use [`make_template_fragment_key`](django.core. ```html+django {% load wagtail_cache %} -{% wagtailpagecache 500 "hero" %} +{% wagtailpagecache 500 hero %} {% endwagtailpagecache %} ``` @@ -368,7 +368,7 @@ This is identical to: ```html+django {% wagtail_site as current_site %} -{% wagtailcache 500 "hero" page.cache_key current_site.id %} +{% wagtailcache 500 hero page.cache_key current_site.id %} {% endwagtailcache %} ```