Normalize adding (and allowing missing) trailing newlines for READMEs.

awsdocs · Nov 27, 2024 · ab6a7d9 · ab6a7d9
1 parent 74733d2
commit ab6a7d9
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/.tools/readmes/render.py b/.tools/readmes/render.py
@@ -304,6 +304,7 @@ def render(self) -> RenderStatus:
             customs=customs,
             unsupported=unsupported,
         )
+        self.readme_text += "\n" # Jinja is the worst and strips trailing new lines
         [text, errors] = expand_all_entities(self.readme_text, self.scanner.doc_gen.entities)
         if errors:
             raise errors

diff --git a/.tools/readmes/runner.py b/.tools/readmes/runner.py
@@ -173,6 +173,12 @@ def main():
 
 def make_diff(renderer, id):
     current = renderer.read_current().split("\n")
+    if current[-1] != "":
+        # Ensure final "last" line
+        current += [""]
     expected = renderer.readme_text.split("\n")
+    if expected[-1] != "":
+        # Ensure final "last" line
+        expected += [""]
     diff = unified_diff(current, expected, f"{id}/current", f"{id}/expected")
     return "\n".join(diff)