fix(document): default to UTF-8 encoding when reading markdown files#54
Open
geopanther wants to merge 1 commit into
Open
fix(document): default to UTF-8 encoding when reading markdown files#54geopanther wants to merge 1 commit into
geopanther wants to merge 1 commit into
Conversation
On systems where the default locale is not UTF-8, open() without an explicit encoding may fail to read valid UTF-8 markdown files, falling through to the chardet-based detection unnecessarily. Adapted from iamjackg/md2cf#139 by @sheyifan.
Owner
Author
Maintainer ReviewVerdict: ✅ Approve Minimal, correct fix. The The existing chardet fallback for non-UTF-8 files remains untouched — good. Note: Python 3.15 will change No concerns. Ship it. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Explicitly pass
encoding='utf-8'when opening markdown files, so systems with non-UTF-8 default locale don't fail on valid UTF-8 content.Adapted from iamjackg/md2cf#139 by @sheyifan.
Changes
encoding='utf-8'to the initialopen()call inget_page_data_from_file_path()UnicodeDecodeErrorfallback with chardet detection remains for non-UTF-8 files