Skip to content

Use UTF-8 for config doc generation #18580

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

Jump to bottom
Merged
merged 5 commits into from
Jul 22, 2025
Merged

Use UTF-8 for config doc generation #18580

merged 5 commits into from
Jul 22, 2025

Conversation

turt2live
Copy link
Member

This fixes the issue on Windows, which uses CP-1251 by default.

Pull Request Checklist

  • Pull request is based on the develop branch
  • Pull request includes a changelog file. The entry should:
    • Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from EventStore to EventWorkerStore.".
    • Use markdown where necessary, mostly for code blocks.
    • End with either a period (.) or an exclamation mark (!).
    • Start with a capital letter.
    • Feel free to credit yourself, by adding a sentence "Contributed by @github_username." or "Contributed by [Your Name]." to the end of the entry.
  • Code style is correct (run the linters)

@turt2live
Use UTF-8 for config doc generation
1f11a15 
This fixes the issue on Windows, which uses CP-1251 by default.
@turt2live turt2live requested a review from a team as a code owner June 19, 2025 17:57
@turt2live turt2live mentioned this pull request Jun 19, 2025
Merged
3 tasks
anoadragon453
anoadragon453 reviewed Jun 20, 2025
View reviewed changes
scripts-dev/gen_config_documentation.py Outdated
Comment on lines 476 to 478
# For Windows: reconfigure the terminal to be UTF-8 for `print()` calls.
if sys.platform == "win32":
sys.stdout.reconfigure(encoding='utf-8')
Copy link
Member

Choose a reason for hiding this comment

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

Is there any reason not to do this for all platforms, especially if we're reading utf-8 on all platforms below?

Copy link
Member Author

Choose a reason for hiding this comment

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

Type checking says it doesn't exist. I was hoping to trick it with a windows check, but seems that's not enough.

@turt2live turt2live requested a review from anoadragon453 July 4, 2025 17:17
anoadragon453
anoadragon453 approved these changes Jul 22, 2025
View reviewed changes
Copy link
Member

@anoadragon453 anoadragon453 left a comment

Choose a reason for hiding this comment

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

lint looks to be happy, therefore so am I! Just a small typo to fix.

The CI failure is unrelated to this PR, see #18537

@anoadragon453 anoadragon453 enabled auto-merge (squash) July 22, 2025 17:42
@anoadragon453 anoadragon453 merged commit a82b8a9 into develop Jul 22, 2025
36 checks passed
@anoadragon453 anoadragon453 deleted the travis/fix-gen-config-docs-win branch July 22, 2025 17:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@anoadragon453 anoadragon453 anoadragon453 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@turt2live @anoadragon453