-
Notifications
You must be signed in to change notification settings - Fork 3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
clarified docs for env-vars and config files #13050
Open
zerothi
wants to merge
5
commits into
pypa:main
Choose a base branch
from
zerothi:13043-docs-env-vars
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
10ccf61
clarified docs for env-vars and config files
zerothi 627a1ae
added towncrier rst
zerothi c28176f
worked on @ichard26 suggestions
zerothi 2a21ccc
Break out PIP_NO_BUILD_ISOLATION footgun warning
ichard26 ab28ee6
Remove unnecesary docs news entry
ichard26 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this part work as is on Windows, or should this part use tabs?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Windows doesn't support the
ENV_VAR=value command
syntax at all. The examples would need to use(CMD syntax), or
(Powershell syntax). I'm not sure whether our Windows examples use CMD or Powershell - the ones I could find work the same in both shells. There's also the complication that if you want multiple examples, you need to unset the variables from the previous example on Windows - again because the
ENV=value cmd
syntax doesn't exist.To be honest, giving explicit examples of shell syntax might be more confusing than helpful for beginners, and advanced users can probably work out the shell syntax based on a description.
One possible compromise would be to use the
env
command -env PIP_VERBOSE=3 PIP_CACHE_DIR=/home/user/tmp pip ...
. Theenv
command doesn't exist by default on Windows, but it's possible to find ports of it. It's not ideal, but it's the only real way of getting a proper Windows equivalent of the Unix examples given (and it has the advantage that it works fine on Unix as well 🙂)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agree on @pfmoore views, there are many places were there is no differentiation between unix/powershell/command.. So I think it can go directly in.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hang on, I was not saying this could be left as it is. Quite the opposite, I was saying that the docs need to be platform-neutral, but that's near-impossible to do in this case, so we should stick with describing the behaviour in the text, without trying to give examples.