Skip to content

Add note recommending pyenv in dev environment docs #11713

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

Merged
merged 1 commit into from
Oct 18, 2024

Conversation

silv-io
Copy link
Member

@silv-io silv-io commented Oct 18, 2024

Motivation

Contributors might get confused by our current documentation stating Python 3.11+ is needed as Python 3.12 does not have full support at this time.
For dev environments we already have a checked in .python-version file in the top level, which would get picked up by any python version manager (e.g., pyenv).
This can already serve as the single source of truth for this.

Changes

  • Remove direct reference to a Python version and instead point to use pyenv
  • If contributors don't want to use pyenv they can also now just quickly have a look at the .python-version and handle the version themselves.

Copy link
Member

@thrau thrau left a comment

Choose a reason for hiding this comment

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

LGTM! good advice :-)

@thrau thrau merged commit c69282d into master Oct 18, 2024
20 of 23 checks passed
@thrau thrau deleted the fix-dev-environment-docs branch October 18, 2024 09:39
@silv-io silv-io added the semver: patch Non-breaking changes which can be included in patch releases label Oct 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
semver: patch Non-breaking changes which can be included in patch releases
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants