Skip to content

docs: Add note about using rich package#9

Merged
peterdragun merged 1 commit intomasterfrom
docs/add_rich_note
Feb 9, 2026
Merged

docs: Add note about using rich package#9
peterdragun merged 1 commit intomasterfrom
docs/add_rich_note

Conversation

@peterdragun
Copy link
Copy Markdown
Collaborator

Based on the issue in esptool, I am adding a new section with known limitations mentioning rich issues and how to avoid the following: https://github.com/espressif/esptool/actions/runs/21666590745/job/62466876686

@github-actions
Copy link
Copy Markdown

github-actions bot commented Feb 9, 2026

Messages
📖 🎉 Good Job! All checks are passing!

👋 Hello peterdragun, we appreciate your contribution to this project!


📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.

Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests via this public GitHub repository.

This GitHub project is public mirror of our internal git repository

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved, we synchronize it into our internal git repository.
4. In the internal git repository we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
5. If the change is approved and passes the tests it is merged into the default branch.
5. On next sync from the internal git repository merged change will appear in this public GitHub repository.

Generated by 🚫 dangerJS against ad49bc7

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds documentation about a known packaging limitation when building PyInstaller binaries that depend on rich, and provides a workaround via additional-args.

Changes:

  • Introduces a new “Known Limitations” section in the README.
  • Documents a PyInstaller workaround for rich Unicode data dynamic imports and shows the expected failure mode.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Copy Markdown
Collaborator

@dobairoland dobairoland left a comment

Choose a reason for hiding this comment

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

LGTM. Thank you!

@peterdragun peterdragun merged commit 1eadb78 into master Feb 9, 2026
2 checks passed
@dobairoland dobairoland deleted the docs/add_rich_note branch February 9, 2026 09:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants