Skip to content

docs: cut the update section down to three commands - #5

Merged
adiazpar merged 2 commits into
mainfrom
docs/simplify-update
Aug 8, 2026
Merged

docs: cut the update section down to three commands#5
adiazpar merged 2 commits into
mainfrom
docs/simplify-update

Conversation

@adiazpar

@adiazpar adiazpar commented Aug 8, 2026

Copy link
Copy Markdown
Contributor

The update section had grown a collapsible essay on how pip resolves git URLs, a
--force-reinstall workaround, and a @ref pinning example.

All of it existed to route around one bug: the version never moved, so --upgrade did
nothing. #4 fixed that. Verified end to end from a stale 0.1.0 environment — plain
pip install --upgrade now uninstalls 0.1.0 and installs 0.2.0.

So the workaround no longer applies, and it is deleted rather than left standing as folklore
someone repeats for years.

What is left is the three things people actually ask:

pip install --upgrade git+https://github.com/doom-snapmap/snapmap-midi.git
pip show -f snapmap-midi
pip uninstall snapmap-midi

pip show -f answers "where is it installed" and "which version do I have" in one command
instead of two. Each was run verbatim against a real install before being written down.

134 passed, 4 skipped.

It had grown a collapsible essay on how pip resolves git URLs, a
--force-reinstall workaround, and a @ref pinning example. All of that
existed to route around one bug: the version never moved, so --upgrade
did nothing.

0.2.0 fixed that. Verified end to end from a stale 0.1.0 environment --
plain `pip install --upgrade` now uninstalls 0.1.0 and installs 0.2.0.
The workaround it worked around no longer applies, so it is gone rather
than left standing as folklore.

What is left is the three things someone actually asks: update it, find
it, remove it. `pip show -f` answers "where is it" and "which version"
in one command instead of two. Each was run verbatim against a real
install before being written down.
A natural thing to wonder, and leaving it unsaid invites a second section
that would duplicate the first. The commands are identical; the only
difference is WHICH installation they act on, which makes activation the
step that matters and `pip show -f` the way to check.

Verified: the same `pip show -f` reports the venv path when activated and
"not found" when not.
@adiazpar
adiazpar merged commit 3e15134 into main Aug 8, 2026
3 checks passed
@adiazpar
adiazpar deleted the docs/simplify-update branch August 8, 2026 15:27
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.

1 participant