docs: clarify env use precedence over active virtualenvs#10985
Open
xu430 wants to merge 2 commits into
Open
Conversation
Document that an explicit `poetry env use` selection (via envs.toml) wins over a shell-activated VIRTUAL_ENV, and how to reset with `poetry env use system`. Fixes python-poetry#8247 Co-authored-by: Xu Mingxuan <207414859+xu430@users.noreply.github.com>
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- The explanation of precedence between
poetry env useandVIRTUAL_ENVis currently split between the ordered list and the later note; consider consolidating or cross-referencing these to avoid repetition and keep the behavior description in one place. - When referring to the “virtualenvs cache” and
envs.toml, it may help to briefly clarify how a user can locate or inspect that file (e.g., viapoetry config virtualenvs.pathor a short pointer) so the reference is immediately actionable.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The explanation of precedence between `poetry env use` and `VIRTUAL_ENV` is currently split between the ordered list and the later note; consider consolidating or cross-referencing these to avoid repetition and keep the behavior description in one place.
- When referring to the “virtualenvs cache” and `envs.toml`, it may help to briefly clarify how a user can locate or inspect that file (e.g., via `poetry config virtualenvs.path` or a short pointer) so the reference is immediately actionable.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Keep precedence in one place, and point readers to `poetry config virtualenvs.path` for locating envs.toml. Co-authored-by: Xu Mingxuan <207414859+xu430@users.noreply.github.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.
Document that an explicit
poetry env useselection (via envs.toml) wins over a shell-activated VIRTUAL_ENV, and how to reset withpoetry env use system.Pull Request Check List
Resolves: #8247