From e4758b29eb1a2f8dad42f6d2d8aa1db5fdccec10 Mon Sep 17 00:00:00 2001 From: Simon Cozens Date: Sun, 3 Mar 2024 08:38:50 +0000 Subject: [PATCH] Add rationale for description/min_length com.google.fonts/check/description/min_length On the Google Fonts Profile. (PR #4570) --- CHANGELOG.md | 1 + Lib/fontbakery/checks/googlefonts/description.py | 8 ++++++++ 2 files changed, 9 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index bd6ec06de4..80acf26718 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -25,6 +25,7 @@ A more detailed list of changes is available in the corresponding milestones for - **[com.google.fonts/check/name/version_format]:** Added rationale. (PR #4570) - **[com.google.fonts/check/name/mandatory_entries]:** Added rationale. (PR #4570) - **[com.google.fonts/check/family/equal_codepoint_coverage]:** Added rationale. (PR #4570) + - **[com.google.fonts/check/description/min_length]:** Added rationale. (PR #4570) #### On the FontValidator profile - **[com.google.fonts/check/fontvalidator]:** Added rationale. (PR #4570) diff --git a/Lib/fontbakery/checks/googlefonts/description.py b/Lib/fontbakery/checks/googlefonts/description.py index ee9e5121dc..1169718647 100644 --- a/Lib/fontbakery/checks/googlefonts/description.py +++ b/Lib/fontbakery/checks/googlefonts/description.py @@ -336,6 +336,14 @@ def com_google_fonts_check_description_valid_html(descfile, description): id="com.google.fonts/check/description/min_length", conditions=["description"], proposal="legacy:check/005", + rationale=""" + The DESCRIPTION.en_us.html file is intended to provide a brief overview of + the font family. It should be long enough to be useful to users, but not so + long that it becomes overwhelming. + + We chose 200 bytes as a minimum length because it suggests that someone has + taken the time to write "something sensible" about the font. + """, ) def com_google_fonts_check_description_min_length(description): """DESCRIPTION.en_us.html must have more than 200 bytes."""