From 1f278085e34d9f2ce2b69eae8f3b212696bad842 Mon Sep 17 00:00:00 2001 From: Nikolaus Waxweiler Date: Thu, 30 Nov 2023 18:28:00 +0000 Subject: [PATCH 1/2] Preserve a check's documentation --- Lib/fontbakery/reporters/serialize.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Lib/fontbakery/reporters/serialize.py b/Lib/fontbakery/reporters/serialize.py index 4b15cffd76..d3e896dd8c 100644 --- a/Lib/fontbakery/reporters/serialize.py +++ b/Lib/fontbakery/reporters/serialize.py @@ -102,6 +102,8 @@ def _register(self, event): if check: item["description"] = check.description + if check.documentation: + item["documentation"] = check.documentation if check.rationale: item["rationale"] = check.rationale if check.experimental: From 466d3c6068488db830ec651caa79bcd59b4f7a81 Mon Sep 17 00:00:00 2001 From: Nikolaus Waxweiler Date: Thu, 30 Nov 2023 19:05:58 +0000 Subject: [PATCH 2/2] Update Changelog --- CHANGELOG.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 260fed5ffa..8293c17ac5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,9 @@ A more detailed list of changes is available in the corresponding milestones for ## Upcoming release: 0.10.5 (2023-Nov-??) +### Note-worthy code changes + - Serialize a check's documentation along with the other properties so reports can get at it. + ### Changes to existing checks #### On the Universal Profile - **[com.google.fonts/check/arabic_spacing_symbols]:** "Check that Arabic spacing symbols U+FBB2–FBC1 aren't classified as marks." Originally implemented in v0.10.2 / **No longer marked as experimental.** (issue #4295) @@ -281,7 +284,7 @@ A more detailed list of changes is available in the corresponding milestones for - Correctly process expected messages when they are plain strings in assert_results_contain() (PR #4015) ### Migrations of checks -#### Moved to the OpenType profile +#### Moved to the OpenType profile - **[com.google.fonts/check/italic_angle]:** from the GoogleFonts profile (issue #3663) - **[com.google.fonts/check/mac_style]:** from the GoogleFonts profile (issue #3664) - **[com.google.fonts/check/fsselection]:** from the GoogleFonts profile (issue #3665)