Repository navigation
Fix the Documentation Making the Modern Version Support Clearer #208
Description
Currently, the documentation says:
9+ releases ship the modern algorithm. Legacy behavior remains the default; use algorithm='modern' for the latest rules. See the migration guide before changing persisted URLs or keys.
Reading this, I was very confused and assumed that it meant 9 or more released versions supported the modern algorithm. It looks like this was changed in commit 6e6fc4b.
Potentially this could be modified to say (or some other clearer verbiage):
Versions 9+ ship the modern algorithm. Legacy behavior remains the default; use algorithm='modern' for the latest rules. See the migration guide before changing persisted URLs or keys.
Activity
docs: clarify '9+ releases' to 'Versions 9+' in README
Jah-yee commentedon Oct 11, 2026
I've submitted PR #210 which clarifies the documentation by changing to . This makes it clear the phrase refers to version numbers rather than release count. Let me know if you'd like any adjustments!
Alexhuszagh commentedon Oct 11, 2026
I think any PRs should be done by the maintainer: my comment includes a potential solution but neither of us are maintainers or long-term contributors so I respectfully don't think we should defer this to the maintainer.
un33k commentedon Oct 11, 2026
Thanks for reporting this, and for pointing to the commit that introduced the wording. You were right: "9+ releases" reads like a count of releases.
Fixed in #209. The README now says "Version 9.0.0 and later" ship the modern algorithm, and that the examples require python-slugify 9.0.0 or later. I verified both claims against a clean 9.0.0 install, and every README example passed.
On your point about who should make the change: fair, and I took it seriously. I reviewed and checked the fix myself before merging it. This is docs only, so there is no new package release.
🚀 Generated with Dojo ⛩️