Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Preserve a check's documentation #4345

Merged
merged 2 commits into from
Nov 30, 2023
Merged

Preserve a check's documentation #4345

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1f27808
Preserve a check's documentation
madig Nov 30, 2023
466d3c6
Update Changelog
madig Nov 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down
2 changes: 2 additions & 0 deletions Lib/fontbakery/reporters/serialize.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down