The README's test setup installs the way CI does - #64
Merged
Conversation
Copilot spotted this on #61 and it went in unresolved. The Tests block told a contributor to run a bare `pip install -e .` right after installing the pinned lockfile — and `setup.py`'s `install_requires` comes from `requirements.in`, the abstract deps, so pip re-resolves what `requirements.txt` had just pinned. CI already gets this right and says why in a comment: # Editable, --no-deps: makes `import SWEET_python` resolve to this # checkout without re-resolving what requirements.txt just pinned So the README was the only place giving the advice CI's own comment warns against. It now matches, with the reason written down. The `pip install -e .` under Installation is deliberately left alone: that is the consumer path, it has no lockfile to protect, and it should resolve its dependencies. Co-Authored-By: Claude Opus 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
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.
Addresses the Copilot comment left unresolved on #61.
The problem
The Tests block told a contributor to run a bare
pip install -e .immediately after installing the pinned lockfile:setup.py'sinstall_requirescomes fromrequirements.in— the abstract deps a consumer gets — so pip re-resolves exactly whatrequirements.txthad just pinned. A contributor following the README ends up on a different dependency set from CI, which is the failure mode a lockfile exists to prevent.CI already gets this right, and says why in a comment:
So the README was the one place giving the advice CI's own comment warns against.
What changed
--no-depson the editable install in the Tests block, plus the reason in prose so the flag does not look like noise a future edit can drop.The
pip install -e .under Installation is deliberately left alone. That is the consumer path — no lockfile to protect, and it should resolve its dependencies.Acceptance criteria
.github/workflows/tests.yml.--no-depsis written down where the command is.Definition of done
🤖 Generated with Claude Code