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

Add reference documentation for pip settings #5125

Merged
merged 1 commit into from
Jul 16, 2024

Conversation

charliermarsh
Copy link
Member

Summary

Third part of #5093.

@charliermarsh charliermarsh marked this pull request as ready for review July 16, 2024 19:41
@charliermarsh charliermarsh added the documentation Improvements or additions to documentation label Jul 16, 2024
@charliermarsh charliermarsh force-pushed the charlie/api-reference-iii branch 2 times, most recently from a2b30e5 to f19b981 Compare July 16, 2024 19:45
Comment on lines +457 to +464
/// Supported formats:
/// - `3.10` looks for an installed Python 3.10 using `py --list-paths` on Windows, or
/// `python3.10` on Linux and macOS.
/// - `python3.10` or `python.exe` looks for a binary with the given name in `PATH`.
/// - `/home/ferris/.local/bin/python3.10` uses the exact Python at the given path.
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 far from comprehensive, just noting for #4400 as I don't think it needs to be addressed here.

@zanieb
Copy link
Member

zanieb commented Jul 16, 2024

I only got part way through here then I think I started reviewing some duplicate content from the stack — I'll look again soon.

@charliermarsh charliermarsh force-pushed the charlie/api-reference-ii branch 3 times, most recently from f74d84f to f06ad3b Compare July 16, 2024 20:41
@charliermarsh
Copy link
Member Author

Thanks -- rebased and updated to reflect feedback on the previous PRs. Note that this is almost all copied from the CLI with minor modifications.

Base automatically changed from charlie/api-reference-ii to main July 16, 2024 20:50
@charliermarsh charliermarsh force-pushed the charlie/api-reference-iii branch 2 times, most recently from f617008 to 8895619 Compare July 16, 2024 20:50
@charliermarsh charliermarsh enabled auto-merge (squash) July 16, 2024 21:07
@charliermarsh charliermarsh merged commit 7211e62 into main Jul 16, 2024
51 checks passed
@charliermarsh charliermarsh deleted the charlie/api-reference-iii branch July 16, 2024 21:14
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.

2 participants