More rationales, better reporting #4570

simoncozens · 2024-03-03T08:49:36Z

Description

Well, I started this PR because the reporting I was getting on a check wasn't very helpful. When we report inconsistencies like ""PANOSE family type is not the same across this family", it would be more useful to know which fonts had value X and which had value Y. So I implemented that.

Then I realised that the check doesn't have a rationale. So I wrote a wee test to see how many checks didn't have rationales, and there were, like, 60 or something. So I started on a rampage adding rationales to checks, and fixing up any other unclear "inconsistency" reporting I found. And of course in doing that I found some checks which I couldn't think of a rationale for, and so this is kind of turning into a general review of most of the checks in the library.

I'll try and keep it restricted to rationales/descriptions and better error messages, and spin off other PRs for other implementation issues.

Checklist

update CHANGELOG.md
wait for the tests to pass
request a review

com.google.fonts/check/family/panose_proportion Removed from the Open Type profile (issue #4083)

felipesanches · 2024-03-04T23:20:57Z

Thanks, @simoncozens. I am still reviewing all changes. Looks good, but I want to carefully craft the changelog entries cross-referencing all relevant issues.

fontbakery.utils.show_inconsistencies Display an 'inconsistencies dictionary' as a bullet list. (PR #4570)

… inconsistencies com.google.fonts/check/family/panose_familytype On the Open Type profile. (PR #4570)

When glyphs needed to compute xAvgCharWidth are missing, it is considered critical, so it is now results in a FATAL-level result. (PR #4570)

com.google.fonts/check/xavgcharwidth On the Open Type profile. (PR #4570)

Mention relevant bit values on the log messages. com.adobe.fonts/check/fsselection_matches_macstyle On the Open Type profile. (PR #4570)

com.google.fonts/check/fsselection On the Open Type Profile. (PR #4570)

com.google.fonts/check/family/equal_unicode_encodings On the Open Type Profile. Note: we may simply deprecate, as we're not sure why would we expect what it checks. (PR #4570)

com.google.fonts/check/ttx_roundtrip On the Universal profile. (PR #4570)

com.google.fonts/check/family/equal_font_versions com.google.fonts/check/font_version On the Open Type Profile. (PR #4570)

com.google.fonts/check/glyf_unused_data com.google.fonts/check/points_out_of_bounds On the Open Type Profile. (PR #4570)

com.google.fonts/check/gpos_kerning_info On the Open Type Profile. (PR #4570)

com.google.fonts/check/maxadvancewidth com.google.fonts/check/loca/maxp_num_glyphs com.google.fonts/check/name/no_copyright_on_description com.adobe.fonts/check/postscript_name com.google.fonts/check/family_naming_recommendations On the Open Type Profile. (PR #4570)

com.google.fonts/check/name/trailing_spaces com.google.fonts/check/ots com.google.fonts/check/whitespace_glyphs com.google.fonts/check/whitespace_ink On the Universal Profile. (PR #4570)

com.google.fonts/check/metadata/broken_links com.google.fonts/check/metadata/menu_and_latin com.google.fonts/check/metadata/copyright On the Google Fonts Profile. (PR #4570)

com.google.fonts/check/metadata/copyright On the Google Fonts Profile. (PR #4570)

com.google.fonts/check/metadata/familyname On the Google Fonts Profile. (PR #4570)

com.google.fonts/check/fontvalidator On the FontValidator Profile. (PR #4570)

com.google.fonts/check/name/version_format com.google.fonts/check/name/mandatory_entries On the Google Fonts Profile. (PR #4570)

com.google.fonts/check/family/equal_codepoint_coverage On the Google Fonts Profile. (PR #4570)

com.google.fonts/check/description/min_length On the Google Fonts Profile. (PR #4570)

com.google.fonts/check/metadata/unknown_designer com.google.fonts/check/metadata/has_regular com.google.fonts/check/metadata/regular_is_400 com.google.fonts/check/metadata/nameid/family_name com.google.fonts/check/metadata/nameid/post_script_name com.google.fonts/check/metadata/nameid/full_name com.google.fonts/check/metadata/match_fullname_postscript com.google.fonts/check/metadata/match_filename_postscript com.google.fonts/check/metadata/valid_full_name_values com.google.fonts/check/metadata/valid_filename_values com.google.fonts/check/metadata/valid_post_script_name_values com.google.fonts/check/metadata/italic_style com.google.fonts/check/metadata/normal_style com.google.fonts/check/metadata/unique_full_name_values com.google.fonts/check/metadata/unique_weight_style_pairs com.google.fonts/check/metadata/reserved_font_name com.google.fonts/check/metadata/nameid/family_and_full_names com.google.fonts/check/metadata/match_name_familyname com.google.fonts/check/metadata/canonical_weight_value On the Google Fonts Profile. (PR #4570)

com.google.fonts/check/metadata/copyright_max_length com.google.fonts/check/metadata/nameid/copyright On the Google Fonts Profile. (PR #4570)

com.google.fonts/check/has_ttfautohint_params On the Google Fonts Profile. (PR #4570)

Providing better fixing instructions. com.google.fonts/check/smart_dropout On the Google Fonts Profile. (PR #4570)

com.google.fonts/check/production_glyphs_similarity On the Google Fonts Profile. (PR #4570)