Skip to content
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.

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

prevent universal_newlines modifying --draft output #525

Open
wants to merge 2 commits into
base: trunk
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/towncrier/build.py
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,8 @@ def __main(
"What is seen below is what would be written.\n",
err=to_err,
)
click.echo(content)
# output as bytes to prevent universal_newlines modifying content #453
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer to have a self contained comment, that explains why this is needed without having to search the internet / GitHub :)

I still don't fully understand what went wrong here and what is the best way to fix it..

As mentioned by Chris, I think that a better idea is to fix this inside render_fragments

click.echo(content.encode("utf8"))
return

click.echo("Writing to newsfile...", err=to_err)
Expand Down