-
-
Notifications
You must be signed in to change notification settings - Fork 31.8k
Docs: Update and proofread library/venv.rst
#124121
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
Conversation
Additionally, It might be worth moving the Another benefit is tooling such as Sphinx Lint primarily process What do you think? |
Agreed; perhaps there once was a reason for it, e.g. being transcluded in some of the old packaging documentation that no longer exists here. Unless there is some need for it now that I'm missing, it seems worth eliminating the extra complexity. |
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 @hugovk ! A handful of additional suggestions for you; otherwise LGTM 👍
Agreed. I think at one point it was just the output of the command line help (so you could replace updated help in it), but it's moved beyond that now. |
Co-authored-by: C.A.M. Gerlach <[email protected]>
Thanks, I've moved the inc into the rst. |
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.
Brief read-through
Co-authored-by: Adam Turner <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
Co-authored-by: Adam Turner <[email protected]>
Thanks @hugovk for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13. |
(cherry picked from commit 23e812b) Co-authored-by: Hugo van Kemenade <[email protected]> Co-authored-by: C.A.M. Gerlach <[email protected]> Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Hugo van Kemenade <[email protected]>
Sorry, @hugovk, I could not cleanly backport this to
|
GH-124644 is a backport of this pull request to the 3.13 branch. |
(cherry picked from commit 23e812b) Co-authored-by: Hugo van Kemenade <[email protected]> Co-authored-by: C.A.M. Gerlach <[email protected]> Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Hugo van Kemenade <[email protected]>
GH-124680 is a backport of this pull request to the 3.12 branch. |
…4644) Docs: Update and proofread `library/venv.rst` (GH-124121) (cherry picked from commit 23e812b) Co-authored-by: Hugo van Kemenade <[email protected]> Co-authored-by: C.A.M. Gerlach <[email protected]> Co-authored-by: Adam Turner <[email protected]>
…4680) * [3.12] Docs: Update and proofread `library/venv.rst` (GH-124121) (cherry picked from commit 23e812b) Co-authored-by: Hugo van Kemenade <[email protected]> Co-authored-by: C.A.M. Gerlach <[email protected]> Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Hugo van Kemenade <[email protected]> * Remove 3.13 docs --------- Co-authored-by: C.A.M. Gerlach <[email protected]> Co-authored-by: Adam Turner <[email protected]>
Content changes:
--without-scm-ignore-files
(plural) was added in GH-83417: Allowvenv
to add a.gitignore
file to environments via a newscm_ignore_file
parameter #108125. When the PR was opened, it was--without-scm-ignore-file
(singular) but changed to plural before merge. Some renamings were missed in the docs. Fix it now, and update the final help text.pyvenv
is documented as deprecated (3.6), but missing the removal (3.8). Document the removal.Suggest
.venv
beforevenv
. Elsewhere we only suggest.venv
as the name, and the linked Python Packaging Guide uses.venv
in examples (the third-party uv also defaults to.venv
).Everything else is proofreading and formatting, see individual commits for details.
This can be backported to 3.13 and 3.12, but 3.12 doesn't have
--without-scm-ignore-files
so will need a manual backport.📚 Documentation preview 📚: https://cpython-previews--124121.org.readthedocs.build/en/124121/library/venv.html