Skip to content

Commit

Permalink
Add rationale for description/min_length
Browse files Browse the repository at this point in the history
com.google.fonts/check/description/min_length
On the Google Fonts Profile.

(PR #4570)
  • Loading branch information
simoncozens authored and felipesanches committed Mar 5, 2024
1 parent 8251e6f commit e4758b2
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
8 changes: 8 additions & 0 deletions Lib/fontbakery/checks/googlefonts/description.py
Original file line number Diff line number Diff line change
Expand Up @@ -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."""
Expand Down

0 comments on commit e4758b2

Please sign in to comment.