Fix changed-in partial when used with multiple paragraphs (#2006)

When used with a text that includes multiple paragraphs, the partial created invalid HTML by nesting `<p>` elements. It also changed the rendering by making "Changed in vX.XX:" a separate paragraph, when it is inline with a single paragraph. To change that we do as with "Required" and add "Changed in vX.XX:" to the text before it is rendered, making it inline with the first paragraph. Signed-off-by: Kévin Commaille <[email protected]>
matrix-org · Nov 26, 2024 · c5eac01 · c5eac01
1 parent f3130f7
commit c5eac01
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 8 deletions.
diff --git a/changelogs/internal/newsfragments/2006.clarification b/changelogs/internal/newsfragments/2006.clarification
@@ -0,0 +1 @@
+Fix `changed-in` partial when used with multiple paragraphs.
diff --git a/layouts/partials/changed-in.html b/layouts/partials/changed-in.html
@@ -1,15 +1,11 @@
-{{/*
+{{- /*
     Renders the "Changed in [version]:" blocks for x-changedInMatrixVersion
     annotations for openapi parameters
 
     Takes a single 'changes_dict' parameter, which should be a map of
     version -> details pairs.
 */ -}}
-{{ range $ver, $details := .changes_dict -}}
-  <p>
-    <strong>
-      Changed in <code>v{{ $ver }}</code>:
-    </strong>
-    {{ $details | markdownify }}
-  </p>
+{{- range $ver, $details := .changes_dict -}}
+    {{- $details = printf "**Changed in `v%s`:** %s" $ver (default "" $details) -}}
+    {{- $details | page.RenderString (dict "display" "block") -}}
 {{ end -}}