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 resolver settings #5122

Merged
merged 1 commit into from
Jul 16, 2024

Conversation

charliermarsh
Copy link
Member

Summary

First part of #5093.

Remaining:

  • Global settings
  • pip-specific settings (some will be copied-over from here)
  • Auto-generating the "Possible values" for enums

@charliermarsh charliermarsh added the documentation Improvements or additions to documentation label Jul 16, 2024
@charliermarsh charliermarsh marked this pull request as ready for review July 16, 2024 19:20
///
/// - `"first-index"`: Only use results from the first index that returns a match for a given package name.
/// - `"unsafe-first-match"`: Search for every package name across all indexes, exhausting the versions from the first index before moving on to the next.
/// - `"unsafe-best-match"`: Search for every package name across all indexes, preferring the "best" version found. If a package version is in multiple indexes, only look at the entry for the first index.
Copy link
Member Author

Choose a reason for hiding this comment

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

Stopped adding these because I'm going to explore auto-generating them in the macro (separately).

@charliermarsh charliermarsh enabled auto-merge (squash) July 16, 2024 20:31
@charliermarsh charliermarsh merged commit 616a61a into main Jul 16, 2024
50 of 51 checks passed
@charliermarsh charliermarsh deleted the charlie/api-reference branch July 16, 2024 20:39
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