mirror of
https://github.com/Abdess/retroarch_system.git
synced 2026-10-20 18:59:07 -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
@@ -80,7 +80,7 @@ class DeploySiteTriggers(unittest.TestCase):
|
||||
)
|
||||
self.assertIn("generate_site.py", entry_points)
|
||||
# mkdocs build runs the hooks mkdocs.yml names: a script of the build.
|
||||
# The file carries Python tags safe_load refuses; the list is plain.
|
||||
# The file carries Python tags safe_load refuses, but the list is plain.
|
||||
mkdocs = (REPO_ROOT / "mkdocs.yml").read_text(encoding="utf-8")
|
||||
hooks = re.search(r"^hooks:\n((?: - .+\n)+)", mkdocs, re.M)
|
||||
entry_points += [
|
||||
@@ -140,7 +140,7 @@ class DocumentedSteps(unittest.TestCase):
|
||||
self.assertEqual(silent, [])
|
||||
|
||||
def test_the_scraper_recipe_names_every_abstract_method(self):
|
||||
"""tools.md said implement fetch_requirements(); validate_format() is
|
||||
"""tools.md said implement fetch_requirements(), but validate_format() is
|
||||
abstract too, and a scraper written from the page could not be built."""
|
||||
source = (SCRIPTS / "scraper" / "base_scraper.py").read_text(encoding="utf-8")
|
||||
abstract = re.findall(r"@abstractmethod\s+def (\w+)", source)
|
||||
|
||||
Reference in new issue
Block a user