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

Incorrect default value for python-preference in docs/reference/settings.md #5754

Closed
FishAlchemist opened this issue Aug 3, 2024 · 1 comment · Fixed by #5755
Closed
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@FishAlchemist
Copy link
Contributor

FishAlchemist commented Aug 3, 2024

According to #5637 , the default value in the document should be changed to "only-managed" because the managed behavior requires --preview. However, if the document is intended for post-stabilization behavior (without --preview), it should also be changed to "managed" instead of using a removed value.
I'm not sure which one should be changed to so I won't create a PR for it

**Default value**: `"installed"`

pub enum PythonPreference {
/// Only use managed Python installations; never use system Python installations.
OnlyManaged,
#[default]
/// Prefer managed Python installations over system Python installations.
///
/// System Python installations are still preferred over downloading managed Python versions.
/// Use `only-managed` to always fetch a managed Python version.
Managed,

Edit (according to my PR):
After referring to #5637 and doing additional testing.
The default value in a stable state seems more reasonable to be only-system. managed in preview.

@charliermarsh
Copy link
Member

Apologies, this changed recently. PR welcome. We can include both the stable and preview value in the default field.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants