◐ Shell
reader mode source ↗
Skip to content

Docs: Update and proofread library/venv.rst#124121

Merged
hugovk merged 17 commits into
python:mainfrom
hugovk:docs-update-venv
Sep 26, 2024
Merged

Docs: Update and proofread library/venv.rst#124121
hugovk merged 17 commits into
python:mainfrom
hugovk:docs-update-venv

Conversation

@hugovk

@hugovk hugovk commented Sep 16, 2024 •
edited by AA-Turner
Loading

Copy link
Copy Markdown
Member

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 hugovk added docs Documentation in the Doc dir needs backport to 3.13 bugs and security fixes labels Sep 16, 2024
@hugovk hugovk requested a review from vsajip as a code owner September 16, 2024 11:24
@hugovk

hugovk commented Sep 16, 2024 •
edited
Loading

Copy link
Copy Markdown
Member Author

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

CAM-Gerlach commented Sep 20, 2024

Copy link
Copy Markdown
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.

CAM-Gerlach
CAM-Gerlach reviewed Sep 20, 2024
View reviewed changes

@CAM-Gerlach CAM-Gerlach left a comment •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hide comment

Thanks @hugovk ! A handful of additional suggestions for you; otherwise LGTM 👍

@vsajip

vsajip commented Sep 21, 2024

Copy link
Copy Markdown
Member

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 and others added 2 commits September 23, 2024 20:55
@hugovk @CAM-Gerlach
Apply suggestions from code review …
02e99ac 
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
@hugovk
Move venv-create.inc into venv.rst
f664390
@hugovk

hugovk commented Sep 23, 2024

Copy link
Copy Markdown
Member Author

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

AA-Turner
AA-Turner reviewed Sep 23, 2024
View reviewed changes

@AA-Turner AA-Turner left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hide comment

Brief read-through

@hugovk @AA-Turner
Apply suggestions from code review …
ca4ed66 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@AA-Turner @hugovk
Update Doc/library/venv.rst …
90f0a63 
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@hugovk @AA-Turner
Apply suggestions from code review …
644a35b 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@hugovk hugovk merged commit 23e812b into python:main Sep 26, 2024
@hugovk hugovk deleted the docs-update-venv branch September 26, 2024 23:57
@miss-islington-app

miss-islington-app Bot commented Sep 26, 2024

Copy link
Copy Markdown

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
@hugovk @CAM-Gerlach
@AA-Turner @miss-islington
Docs: Update and proofread library/venv.rst (pythonGH-124121) …
6b2e459 
(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>
@miss-islington-app

miss-islington-app Bot commented Sep 26, 2024

Copy link
Copy Markdown

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

bedevere-app Bot commented Sep 26, 2024

Copy link
Copy Markdown

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
@hugovk @CAM-Gerlach @AA-Turner
[3.12] Docs: Update and proofread library/venv.rst (pythonGH-124121) …
48ce591 
(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>
@bedevere-app

bedevere-app Bot commented Sep 27, 2024

Copy link
Copy Markdown

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
@miss-islington @hugovk
@CAM-Gerlach @AA-Turner
[3.13] Docs: Update and proofread library/venv.rst (GH-124121) (#12… …
4c97ed4 
…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>
Yhg1s pushed a commit that referenced this pull request Sep 30, 2024
@hugovk @CAM-Gerlach @AA-Turner
[3.12] Docs: Update and proofread library/venv.rst (GH-124121) (#12… …
0037717 
…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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@AA-Turner AA-Turner

@CAM-Gerlach CAM-Gerlach CAM-Gerlach left review comments

@vsajip vsajip Awaiting requested review from vsajip vsajip is a code owner

Assignees

@hugovk hugovk

Labels

docs Documentation in the Doc dir skip issue skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@hugovk @CAM-Gerlach @vsajip @AA-Turner