docs(install): add mm --version verify + --refresh hint for PyPI cache lag#393
Merged
docs(install): add mm --version verify + --refresh hint for PyPI cache lag#393
mm --version verify + --refresh hint for PyPI cache lag#393Conversation
…cache lag First-time users can install a stale version because `uv` caches PyPI index metadata per package, so `uv tool install memtomem` can resolve to a cached older entry for a short window right after a new release. Neither the verify step (`mm --version`) nor the remediation (`--refresh` / `uv cache clean memtomem`) was mentioned anywhere in the public docs. Add a verify line inside each of the three first-touch install blocks (repo README, PyPI README, getting-started guide) and a short blockquote callout that links to the releases page and shows both remediations. Closes #390. Co-Authored-By: Claude <[email protected]>
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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.
Summary
mm --versionas a verify step inside all three first-touch install blocks (repoREADME.md, PyPIpackages/memtomem/README.md,docs/guides/getting-started.md).uv tool install memtomem --refreshanduv cache clean memtomem).Closes #390.
Why
A first-time user running
uv tool install memtomemright after a new release can get a stale version becauseuvcaches PyPI index metadata per package. This was observed after v0.1.22 / v0.1.23 and is documented internally as a recurring pattern. Before this PR,--refreshappeared in 0 places across the public docs surface (repo README + PyPI README +docs/), and no doc had a verify step the user could run to notice the problem.On a fresh test run in this session (cache cleaned beforehand),
uv tool install memtomemcorrectly fetched v0.1.24 — so the stale-version path didn't reproduce locally this time, but the issue is time-windowed and hits whoever installs during the stale window.Test plan
mm --versionis a real subcommand that prints the installed version. Verified in a fresh tool env:memtomem 0.1.24.uv tool install memtomem --refreshis a documenteduvflag (uv tool install --help).uv cache clean memtomemis a documenteduvcommand (uv cache clean --help— accepts a package arg).https://github.com/memtomem/memtomem/releasesresolve.Scope
Out of scope (separate issues):
[all]extras primary-install choice — docs/install: primary install command omits [all] extras — decide include vs justify #391.mmnot on PATH afteruv tool install— docs/install: add post-install "which mm" verify and "uv tool update-shell" fallback #392.🤖 Generated with Claude Code