GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Docs: Update and proofread `library/venv.rst` by hugovk · Pull Request #124121 · python/cpython

Conversation

@hugovk

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

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
savannahostrowski and CAM-Gerlach reacted with heart emoji
All reactions
  • ❤️ 2 reactions
hugovk added 12 commits September 16, 2024 13:30
@hugovk
Suggest .venv before venv
4f8b2d5
@hugovk
Proofreading
8b96ad7
@hugovk
Document pyvenv was removed in 3.8
09d9bff
@hugovk
Fix without-scm-ignore-file -> without-scm-ignore-files option and he…
a490193 
…lp text
@hugovk
Realign --help to match output
694c65d
@hugovk
Sort versionchanged oldest first, like elsewhere
fc04bdd
@hugovk
Highlight console commands
ead0426
@hugovk
Replace Latin abbreviation
f15cded
@hugovk
Code font for directory names
388351a
@hugovk
Git is the SCM, git is a command
552a786
@hugovk
Parameters in italics
76c6bcf
@hugovk
program formatting
2afa69d
@hugovk hugovk added docs Documentation in the Doc dir needs backport to 3.13 only security fixes labels Sep 16, 2024
@hugovk
hugovk requested a review from vsajip as a code owner September 16, 2024 11:24
@bedevere-app bedevere-app Bot added the awaiting core review label Sep 16, 2024
@hugovk hugovk added needs backport to 3.12 only security fixes awaiting core review skip issue skip news and removed awaiting core review labels Sep 16, 2024
@hugovk

hugovk commented Sep 16, 2024 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

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 reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@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.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
CAM-Gerlach
CAM-Gerlach reviewed Sep 20, 2024
View reviewed changes

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

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

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 👍

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread Doc/library/venv.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/library/venv.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/library/venv.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/library/venv.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/using/venv-create.inc Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/using/venv-create.inc Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/using/venv-create.inc Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/using/venv-create.inc Resolved

Uh oh!

There was an error while loading. Please reload this page.
@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.
CAM-Gerlach and hugovk reacted with thumbs up emoji
All reactions
  • 👍 2 reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
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 <[email protected]>
@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.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
AA-Turner
AA-Turner reviewed Sep 23, 2024
View reviewed changes

@AA-Turner AA-Turner left a comment

Copy link
Copy Markdown
Member

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread Doc/library/venv.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/library/venv.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/library/venv.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
@hugovk @AA-Turner
Apply suggestions from code review
ca4ed66 
Co-authored-by: Adam Turner <[email protected]>
@AA-Turner @hugovk
Update Doc/library/venv.rst
90f0a63 
Co-authored-by: Hugo van Kemenade <[email protected]>
AA-Turner
AA-Turner approved these changes Sep 25, 2024
View reviewed changes
Comment thread Doc/library/venv.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/library/venv.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app bedevere-app Bot added awaiting merge and removed awaiting core review labels Sep 25, 2024
AA-Turner
AA-Turner reviewed Sep 25, 2024
View reviewed changes
Comment thread Doc/library/venv.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
@hugovk @AA-Turner
Apply suggestions from code review
644a35b 
Co-authored-by: Adam Turner <[email protected]>
@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.
🐍🍒⛏🤖
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app bedevere-app Bot removed the awaiting merge label Sep 26, 2024
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 <[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

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
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@miss-islington-app miss-islington-app Bot assigned hugovk Sep 26, 2024
@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.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app bedevere-app Bot removed the needs backport to 3.13 only 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 <[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

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.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@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 <[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
@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 <[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

Reviewers

@AA-Turner AA-Turner AA-Turner approved these changes
@CAM-Gerlach CAM-Gerlach CAM-Gerlach left review comments
@vsajip vsajip Awaiting requested review from vsajip vsajip is a code owner

Uh oh!

There was an error while loading. Please reload this page.

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.

Uh oh!

There was an error while loading. Please reload this page.

4 participants

@hugovk @CAM-Gerlach @vsajip @AA-Turner
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.