Skip to content
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

Fix documentation for python platform #3220

Merged
merged 1 commit into from
Apr 23, 2024

Conversation

neumann-nico
Copy link
Contributor

@neumann-nico neumann-nico commented Apr 23, 2024

Summary

The option --platform for uv pip compile was added in #3111 and was later renamed to --python-platform #3146.
This PR updates the documentation such that the listed option is working again.

Test Plan

❯ uv --version
uv 0.1.37 (645d0399f 2024-04-23)

Before:

❯ uv pip compile requirements.in --platform=linux
error: unexpected argument '--platform' found

  tip: to pass '--platform' as a value, use '-- --platform'

Usage: uv pip compile <SRC_FILE>...

For more information, try '--help'.

After:

❯ uv pip compile requirements.in --python-platform=linux
Resolved 1 package in 215ms
# This file was autogenerated by uv via the following command:
#    uv pip compile requirements.in --python-platform=linux
uv==0.1.37

Copy link
Member

@zanieb zanieb left a comment

Choose a reason for hiding this comment

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

Thank you!

@zanieb zanieb added the documentation Improvements or additions to documentation label Apr 23, 2024
@zanieb zanieb enabled auto-merge (squash) April 23, 2024 20:05
@zanieb zanieb merged commit f0c0f87 into astral-sh:main Apr 23, 2024
39 checks passed
@neumann-nico neumann-nico deleted the python_platform_docs branch April 23, 2024 20:09
@charliermarsh
Copy link
Member

Tyvm.

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.

3 participants