Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 27, 2024
Merged

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ab6a7d9
Normalize adding (and allowing missing) trailing newlines for READMEs.
DavidSouther Nov 27, 2024
205080c
Ensure ending newline in renderer, rather than renderer and diff
DavidSouther Nov 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion .tools/readmes/render.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -332,7 +333,11 @@ def write(self):
def read_current(self):
try:
with self.readme_filename.open("r", encoding="utf-8") as f:
return f.read()
current = f.read()
if current[-1] != "\n":
# Ensure there's always an ending newline
current += "\n"
return current
except FileNotFoundError:
return ""

Expand Down