-
-
Notifications
You must be signed in to change notification settings - Fork 31.8k
Use replacements to update versions in "Using Python on macOS" #130400
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
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for doing this. Note there are still some hardwired 3.13 path references in the Advanced Topics section; it would be nice to address those, too.
Thanks, I've replaced some more. Unfortunately the formatting isn't as good, but I think it's acceptable from a maintenance point of view, if there's no better solution?
But I've not replaced the hardcoded versions in this section, I don't have a good method for that: https://docs.python.org/dev/using/mac.html#installing-using-the-command-line |
Would an alternative be to have a test/lint ensuring that the version is current? It would be a shame to accept strictly worse aesthetics for a tooling problem. A |
That could work, what sort of thing do you have in mind? Of course, it would be great if Sphinx directly supported replacements in code blocks ;) Oh, I've just discovered parsed literal blocks:
This gives improved formatting, although no syntax highlighting:
|
I struggled with how to handle versions in formatted code when I did the rewrite for 3.13. I'm glad I'm not the only one! If it could be done without a lot of trouble, the linting solution sounds fine until (if ever) there is a better solution with Sphinx / Docutils as this only needs to be updated once a year. But I'll leave it up to you(s). |
So the versions in https://docs.python.org/3.13/using/mac.html and https://docs.python.org/3.14/using/mac.html aren't hardcoded to "3.13", and reflect the current version.
📚 Documentation preview 📚: https://cpython-previews--130400.org.readthedocs.build/