Repository navigation
Announce 2.4 in the README - #649
Merged
Merged
Conversation
The README is the PyPI project page, so it should lead with the release it ships in. The 2.0 compatibility promise stays as a pointer to Coming from 1.x, East Asian support becomes a standing feature sentence, and the quick start shows the credential reading. Checked with python -m doctest and readme_renderer. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #649 +/- ##
=======================================
Coverage 99.02% 99.02%
=======================================
Files 46 46
Lines 4513 4513
=======================================
Hits 4469 4469
Misses 44 44 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The README is the PyPI project page; 2.4.0 nearly shipped announcing 2.0 and 2.1. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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
1 participant
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.
The README is the PyPI project page, and it still announced 2.0 and 2.1. This lands before the
v2.4.0tag so the 2.4.0 upload carries it.New announcement: one 2.4 paragraph replaces the 2.0 and 2.1 blurbs. Its examples are the release log's own summary examples:
Jack MA/Jack MaandJane Smith, PhD MA.East Asian support: a standing feature sentence now, instead of a "2.1 adds" announcement.
Compatibility promise: existing
HumanNamecode keeps working, with a link to "Coming from 1.x".Quick start: three credential lines are added. They run as part of the README doctest.
Release checklist: step 0's sweep list in AGENTS.md gains the README announcement, with the two commands that check it.
Test plan
python -m doctest README.rstpassesreadme_renderer(PyPI's renderer) renders it with exit 0, and the "Coming from 1.x" link resolves🤖 Generated with Claude Code