docs: tidy conformance table + drop shields.io badges from compliance report#24
Merged
Merged
Conversation
… report README — collapse the duplicate Cases column into Status The conformance table had Cases (e.g. ``366``) and Status (e.g. ``366 / 366``) sitting side by side. Status already carries Cases in its numerator, so the extra column was pure noise. Now: just Suite / Source / Status. Adds a U+2705 WHITE HEAVY CHECK MARK (✅) to each pass row — rendered as a green check by GitHub, PyPI, the docs site, and every other CommonMark renderer (raw Unicode rather than ``:white_check_mark:`` so it survives PyPI's long-description rendering, which doesn't expand emoji shortcodes). docs/wpt-compliance.md — drop the top-of-page shields.io badge row The five shields.io badges at the top of the report duplicated the per-suite counts that the Summary table immediately below them already carries. shields.io's URL encoding also mis-parses labels with embedded hyphens (``urlpattern-constructor.any.js`` truncates at the first ``-``), so several of the badges 404'd in practice. Removing the row leaves the report jumping straight from the run-metadata header to the Summary table. scripts/generate_compliance_report.py — remove the now-unused badge plumbing Dropped ``_badge``, ``_suite_badge``, the ``COLOR_*`` constants, the top-of-page badge emission block, and the shields.io references in the module docstring + section comment. The status-symbol palette (✓ / ✗ / ◐ / ◑ / ⚠) is untouched; per-case rows still pair every glyph with a status word for accessibility. No code changes outside the report generator; docs only.
github-actions
Bot
added
the
documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Two small cleanups, both prompted by feedback on the rendered docs:
Casescolumn intoStatus(the numerator already carries it) and switch the status indicator from<kbd>✓</kbd>to a raw U+2705 ✅ green check.docs/wpt-compliance.md— drop the five shields.io badges at the top of the report. They duplicated the Summary table directly below them, and shields.io's URL encoding mis-parses labels with embedded hyphens (e.g.urlpattern-constructor.any.jstruncates at the first-), so several 404'd in practice.Why raw Unicode for the check
:white_check_mark:is the GitHub-idiomatic shortcode, but README.md is this project's PyPI long_description viahatch fancy-pypi-readme. PyPI's CommonMark renderer doesn't expand emoji shortcodes — it would show the literal text:white_check_mark:on the package page. Raw Unicode ✅ renders consistently on GitHub, PyPI, the docs site, and any other CommonMark renderer.What changes
README
Before — four columns;
Casesis a redundant numerator:urlpattern.any.jsurlpatterntestdata.jsonAfter — three columns; pass marker upgraded to green ✅:
urlpattern.any.jsurlpatterntestdata.jsondocs/wpt-compliance.mdFive top-of-page shields.io badges removed. Run-metadata header now flows directly into the Summary table — the table already enumerates Total / Pass / XFail / Skip / Fail / Error per suite.
scripts/generate_compliance_report.py_badge,_suite_badge, and the badge-emission block in_render.COLOR_PASS/COLOR_FAIL/COLOR_XFAIL/COLOR_SKIP/COLOR_ERRORconstants.Test plan
just compliance-report— regeneratesdocs/wpt-compliance.mdas 469 cases, 0 failingjust docs— strict-mode site build cleanjust lint— all tools green (ruff, mypy, pyright, ty, semgrep, shellcheck, rumdl, codespell, interrogate, validate-pyproject)No source-code changes outside the report generator; docs only.