docs: write prose without dashes or semicolons

Profiles, the wiki, comments, docstrings, command output and schema descriptions carried em-dashes, clause-joining semicolons, unicode arrows, box-drawing banners and check-mark glyphs. Each sentence was rewritten rather than having its character swapped. Hashes, paths, source_ref values and every cited file:line are unchanged, which a comparison of each parsed profile against the previous revision confirms.

validate_pr comments now say PASS and FAIL in words, and source_ref values in a profile's structured blocks render as code. test_prose_style fails if any of these comes back, in tracked files or in the generated site.
This commit is contained in:
Abdessamad Derraz committed 2026-10-19 06:47:31 +02:00
1 parent 583031eda5
commit 4231902a6c
495 files changed
+2486 -2301

No files matched your search

+2 -2
View File
@@ -170,7 +170,7 @@ def pinned_base(wanted: dict[str, str], scraped: dict | None) -> str:
def _raw_url(url: str) -> str:
"""A GitHub blob page names a revision but serves HTML; raw serves bytes."""
"""A GitHub blob page names a revision but serves HTML, raw serves bytes."""
marker = "/blob/"
if url.startswith("https://github.com/") and marker in url:
owner_repo, _, path = url[len("https://github.com/") :].partition(marker)
@@ -203,7 +203,7 @@ _RAW_GITHUB = re.compile(r"^https://raw\.githubusercontent\.com/([^/]+)/([^/]+)/
def _at_revision(url: str, base: str) -> str:
"""A file of the pinned repository, read at the pinned revision; empty
"""A file of the pinned repository, read at the pinned revision, empty
when the URL is not a raw GitHub URL of that repository.
ROCKNIX's checker sits in packages/rocknix/, the emulators it names in