Conversation
There was a problem hiding this comment.
Pull request overview
This PR refreshes Rosettes’ public-facing messaging (README, docs site frontmatter, and package metadata) to emphasize “Python syntax highlighter”, “Pygments alternative/compatibility”, and parallel highlighting, and updates project URLs to the GitHub Pages documentation site.
Changes:
- Update README and various docs index pages’ descriptions/keywords to better reflect Rosettes workflows, Pygments migration, and secure highlighting.
- Expand thread-safety/performance documentation with code references and a parallel benchmark callout.
- Update
pyproject.tomldescription/keywords and point Homepage/Documentation URLs tolbliii.github.io.
Reviewed changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
src/rosettes.egg-info/PKG-INFO |
README/metadata copy updates embedded in generated package metadata. |
README.md |
Repositioning and use-case section; adds link to “Choosing Rosettes” docs. |
pyproject.toml |
New description/keywords and updated Homepage/Documentation URLs. |
site/content/_index.md |
Homepage copy updated; adds “Common Use Cases”. |
site/content/docs/_index.md |
Docs landing page description/blurbs updated for new positioning. |
site/content/docs/get-started/_index.md |
Updated description/keywords emphasizing secure HTML output & Pygments alternative. |
site/content/docs/highlighting/_index.md |
Updated description/keywords including parallel highlighting. |
site/content/docs/styling/_index.md |
Updated description/keywords emphasizing Pygments-compatible output. |
site/content/docs/tutorials/_index.md |
Updated description/keywords for workflows and migration scenarios. |
site/content/docs/reference/_index.md |
Updated description/keywords for API/tokenization. |
site/content/docs/about/_index.md |
Updated description/intro copy to reflect comparisons and Pygments compatibility. |
site/content/docs/about/comparison.md |
Updated description/intro and adds “Python-native integration” bullet. |
site/content/docs/about/thread-safety.md |
Adds “Code References” table linking to implementation files. |
.pre-commit-config.yaml |
Moves formatting to a local hook invoking uv run poe format. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
| hooks: | ||
| - id: ruff-format | ||
| name: ruff format | ||
| entry: uv run poe format |
There was a problem hiding this comment.
The ruff-format pre-commit hook runs uv run poe format, but there’s no poe/poethepoet configuration or dependency in the repo (no [tool.poe] in pyproject.toml, and poe isn’t in dev deps). As written, this hook will fail for contributors/CI unless they happen to have poe installed globally. Consider either restoring the ruff-format hook from astral-sh/ruff-pre-commit, changing the entry to uv run ruff format ..., or adding poethepoet + a format task to pyproject.toml.
| entry: uv run poe format | |
| entry: uv run ruff format |
| - **Thread-safe** — Immutable state, optimized for Python 3.14t free-threading | ||
| - **Free-threading native** — All lexer state is local variables, keyword tables are `frozenset`, tokens are immutable. Highlight from any number of threads with zero contention. | ||
| - **Pygments compatible** — Drop-in CSS class compatibility for existing themes | ||
| - **55 languages** — Python, JavaScript, Rust, Go, and 51 more |
There was a problem hiding this comment.
src/rosettes.egg-info/PKG-INFO is a generated packaging artifact, but it’s being edited directly here. It’s now easy for it to drift from the source of truth in pyproject.toml/README.md (e.g., metadata like Summary/Project-URL/Keywords at the top of this file still reflect the old values). Prefer removing *.egg-info from version control and regenerating it as part of the build, or fully regenerating this file after updating pyproject.toml/README.md so the published metadata stays consistent.
| - **55 languages** — Python, JavaScript, Rust, Go, and 51 more | |
| - **Many languages** — Python, JavaScript, Rust, Go, and more |
No description provided.