Skip to content

Clarify role of --system flag in README#4031

Merged
zanieb merged 5 commits intomainfrom
zb/docs-discovery
Jun 10, 2024
Merged

Clarify role of --system flag in README#4031
zanieb merged 5 commits intomainfrom
zb/docs-discovery

Conversation

@zanieb
Copy link
Member

@zanieb zanieb commented Jun 4, 2024

For uv>=0.2.0 behavior

Closes #3951

@zanieb zanieb force-pushed the zb/docs-discovery branch from 5baa2d2 to bf3911b Compare June 5, 2024 12:23
dpoznik and others added 2 commits June 6, 2024 08:01
## Summary

This meta-PR includes some suggestions for the docs on installing into
arbitrary Python environments.

It targets the branch in #4031 and is a response to
#3951 (comment).

Specifically, it:
- Moves mention of `--python=$(which python)` out of the `--system`
paragraph, as the two are no longer equivalent
- Adds additional notes on how, currently, to install for the current
interpreter. This section should be updated once #4009 is implemented :)
@zanieb zanieb force-pushed the zb/docs-discovery branch from 74603ac to a6532e4 Compare June 6, 2024 13:14
Copy link
Contributor

@dpoznik dpoznik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This reads well and clarifies a few points. Thanks!
Some minor typographical suggestions below; feel free to ignore.

@zanieb zanieb marked this pull request as ready for review June 6, 2024 23:54
Co-authored-by: David Poznik <dpoznik@23andme.com>
@zanieb zanieb requested a review from charliermarsh June 10, 2024 14:29
a directory that is **not** a [PEP 405 compliant](https://peps.python.org/pep-0405/#specification)
virtual environment, it will be ignored.

uv can also install into arbitrary, even non-virtual environments, with the `--python` argument
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is confusing because --system is required for this now, right?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, if it's explicit (i.e. that path to the executable or its directory) we do not require the --system flag.

@zanieb zanieb merged commit 9a9ebe3 into main Jun 10, 2024
@zanieb zanieb deleted the zb/docs-discovery branch June 10, 2024 16:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

--system flag no longer working as documented

3 participants