mirror of
https://github.com/Abdess/retroarch_system.git
synced 2026-10-23 20:29:06 -05:00
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:
1 parent
583031eda5
commit
4231902a6c
495 files changed
+2486
-2301
No files matched your search
@@ -68,7 +68,7 @@ def compare(
|
||||
against the collection's: a dump rebuilt at its old size and never
|
||||
re-uploaded was invisible to a size comparison.
|
||||
|
||||
*registered* is every path .gitignore lists; an asset name depends on
|
||||
*registered* is every path .gitignore lists. An asset name depends on
|
||||
which other paths share its basename, so it defaults to *expected* only
|
||||
when the caller has nothing wider. A release description that no longer
|
||||
matches what render_notes() would write is a finding of its own: the
|
||||
@@ -182,8 +182,8 @@ def render_notes(
|
||||
"""The release page, from what the release actually serves.
|
||||
|
||||
Every asset gets one row. A file the database indexes carries its
|
||||
database SHA1; a data-directory bundle carries the hash of its cached
|
||||
copy when one exists; anything else is listed apart with its size only,
|
||||
database SHA1, a data-directory bundle carries the hash of its cached
|
||||
copy when one exists, and anything else is listed apart with its size only,
|
||||
so the page never vouches for bytes nobody indexed. Descriptions and
|
||||
sections already written by hand are kept by name.
|
||||
"""
|
||||
|
||||
Reference in new issue
Block a user