README.md - people should use exactly 3.13, update instructions about pyenv #62
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jarofgreen
force-pushed
the
update-readme-python-13
branch
from
c78486d to
be8f874
Compare
jarofgreen
force-pushed
the
update-readme-python-13
branch
from
be8f874 to
550e29e
Compare
duncandewhurst
requested changes
May 11, 2025
| @@ -24,13 +24,22 @@ Subsequent instructions assume that your current working directory is `os4d`, un | |||
|
|
|||
| #### Create and activate a Python virtual environment | |||
|
|
|||
| The following instructions assume you have [Python 3.10](https://www.python.org/downloads/) or newer installed on your machine. | |||
| The following instructions assume you have [Python 3.13](https://www.python.org/downloads/) installed on your machine, as we need to use the same version of python the docs are built with. | |||
There was a problem hiding this comment.
Since the instructions now include installing Python 3.13, I think it's simpler to state it as a requirement, rather than an assumption followed by a 'need to' clause.
Suggested change
| The following instructions assume you have [Python 3.13](https://www.python.org/downloads/) installed on your machine, as we need to use the same version of python the docs are built with. | |
| The build requires [Python](https://www.python.org/downloads/) 3.13. |
Comment on lines
+29
to
+31
| If you already have 3.13 you can use `python3-venv` or a Python environment manager of your choice. | ||
|
|
||
| If not we recommend pyenv. |
There was a problem hiding this comment.
Suggested change
| If you already have 3.13 you can use `python3-venv` or a Python environment manager of your choice. | |
| If not we recommend pyenv. | |
| If you already have Python 3.13 installed, you can create a virtual environment using [pyenv-virtualenv](https://github.com/pyenv/pyenv-virtualenv), `python3-venv`, or a Python environment manager of your choice. | |
| If not, we recommend using `pyenv` to install Python 3.13 and `pyenv-virtualenv` to create a virtual environment. |
Comment on lines
+36
to
+42
| 1. Set up Python 3.13 using pyenv: | ||
|
|
||
| ```bash | ||
| pyenv install 3.13 | ||
| pyenv local 3.13 | ||
| ``` | ||
|
|
There was a problem hiding this comment.
I don't have pyenv on my machine any more, but I'm pretty sure that you can just do pyenv virtualenv 3.13 os4d at the next step, which makes the instructions the same regardless of whether the reader already has Python 3.13 installed or not.
|
I think we should also remove the first clause from the following sentence, since anyone reading this bit should have Python 3.13 installed. Line 63 in 550e29e |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.