About: Use BOM to decode UTF-16 changelog file #3601
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
If the Windows changelog text file (which is encoded UTF-16LE with a Byte Order Marker at the start) is explicitly opened as
utf_16_le
, the BOM will be left in the stream, which throws off the parsing ofthe first line. Using
encoding="utf_16"
automatically filters out the BOM after using it to determine the file endianness.Fixes: A Windows-only issue reported at #3401 (comment)