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
@@ -35,7 +35,7 @@ def load_provenance_snapshots(provenance_dir: str = DEFAULT_PROVENANCE_DIR) -> d
def build_provenance_index(snapshots: dict) -> dict:
"""Index snapshot entries by sha1 and by (md5, size) per source.
First entry wins on hash collisions within a source; entries are
First entry wins on hash collisions within a source. Entries are
pre-sorted at snapshot write time so the outcome is deterministic.
"""
index = {}
@@ -95,7 +95,7 @@ def build_snapshot(
def write_snapshot(path: str, snapshot: dict) -> bool:
"""Write a snapshot; timestamps alone never count as a change."""
"""Write a snapshot. Timestamps alone never count as a change."""
return write_if_changed(path, json.dumps(snapshot, indent=2) + "\n")