Skip to content

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

Merged
merged 17 commits into from
Sep 26, 2024
Merged

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Sep 16, 2024

Content changes:

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

@hugovk
Copy link
Member Author

hugovk commented Sep 16, 2024

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?

@CAM-Gerlach
Copy link
Member

It might be worth moving the .inc contents into the .rst and deleting the .inc. [...] 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.

Copy link
Member

@CAM-Gerlach CAM-Gerlach left a 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 👍

@vsajip
Copy link
Member

vsajip commented Sep 21, 2024

It might be worth moving the .inc contents into the .rst and deleting the .inc

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.

@hugovk
Copy link
Member Author

hugovk commented Sep 23, 2024

Thanks, I've moved the inc into the rst.

Copy link
Member

@AA-Turner AA-Turner left a 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: Hugo van Kemenade <[email protected]>
@hugovk hugovk merged commit 23e812b into python:main Sep 26, 2024
23 checks passed
@hugovk hugovk deleted the docs-update-venv branch September 26, 2024 23:57
@miss-islington-app
Copy link

Thanks @hugovk for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 26, 2024
(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]>
@miss-islington-app
Copy link

Sorry, @hugovk, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 23e812b84ae688a56a1011ed69a0d178c70e35ea 3.12

@bedevere-app
Copy link

bedevere-app bot commented Sep 26, 2024

GH-124644 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Sep 26, 2024
hugovk added a commit to hugovk/cpython that referenced this pull request Sep 27, 2024
(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]>
@bedevere-app
Copy link

bedevere-app bot commented Sep 27, 2024

GH-124680 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Sep 27, 2024
Yhg1s pushed a commit that referenced this pull request Sep 27, 2024
…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]>
Yhg1s pushed a commit that referenced this pull request Sep 30, 2024
…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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants