Docs: Update and proofread library/venv.rst - #124121
Conversation
Sorry, something went wrong.
|
Additionally, Doc/using/venv-create.inc is only included by Doc/library/venv.rst. It might be worth moving the .inc contents into the .rst and deleting the .inc. One big benefit is IDE's are better at recognising .rst is reStructuredText and doing syntax highlighting and autocompletion, whereas .inc is shown as a monochrome plaintext file (PyCharm suggested plugins for PHP and Assembly...). Another benefit is tooling such as Sphinx Lint primarily process .rst files. What do you think? |
Sorry, something went wrong.
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. |
Sorry, something went wrong.
There was a problem hiding this comment.
Thanks @hugovk ! A handful of additional suggestions for you; otherwise LGTM 👍
Sorry, something went wrong.
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. |
Sorry, something went wrong.
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
|
Thanks, I've moved the inc into the rst. |
Sorry, something went wrong.
AA-Turner
left a comment
There was a problem hiding this comment.
Brief read-through
Sorry, something went wrong.
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
|
Thanks @hugovk for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13. |
Sorry, something went wrong.
(cherry picked from commit 23e812b) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
|
Sorry, @hugovk, I could not cleanly backport this to 3.12 due to a conflict. cherry_picker 23e812b84ae688a56a1011ed69a0d178c70e35ea 3.12 |
Sorry, something went wrong.
|
GH-124644 is a backport of this pull request to the 3.13 branch. |
Sorry, something went wrong.
(cherry picked from commit 23e812b) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
|
GH-124680 is a backport of this pull request to the 3.12 branch. |
Sorry, something went wrong.
…4644) Docs: Update and proofread `library/venv.rst` (GH-124121) (cherry picked from commit 23e812b) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
…4680) * [3.12] Docs: Update and proofread `library/venv.rst` (GH-124121) (cherry picked from commit 23e812b) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> * Remove 3.13 docs --------- Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Content changes:
--without-scm-ignore-files (plural) was added in GH-83417: Allow venv to add a .gitignore file to environments via a new scm_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 before venv. 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