docs: improve venv docs #124540
Merged
docs: improve venv docs #124540
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Move "versionchanged" notes that apply to the whole class to the end of the class docs - Remove or move notes next to the method list that apply to individual methods. - Mark up parameters using the appropriate syntax - Do not capitalize "boolean" - Shorten some text
bedevere-app
bot
added
awaiting core review
docs
AlexWaygood
approved these changes
Sep 25, 2024
| @@ -168,31 +168,31 @@ creation according to their needs, the :class:`EnvBuilder` class. | |||
| The :class:`EnvBuilder` class accepts the following keyword arguments on | |||
| instantiation: | |||
|
|
|||
| * ``system_site_packages`` -- a Boolean value indicating that the system Python | |||
| * *system_site_packages* -- a boolean value indicating that the system Python | |||
There was a problem hiding this comment.
We could also consider using a parameter list for this (which would render similar to https://docs.python.org/3/library/sqlite3.html#sqlite3.connect). But it's okay if you want to declare that out of scope for this PR :-)
AlexWaygood
added
needs backport to 3.12
vsajip
approved these changes
Sep 28, 2024
|
Thanks @JelleZijlstra 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 28, 2024
- Move "versionchanged" notes that apply to the whole class to the end of the class docs - Remove or move notes next to the method list that apply to individual methods. - Mark up parameters using the appropriate syntax - Do not capitalize "boolean" - Shorten some text (cherry picked from commit c976d78) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
|
Sorry, @JelleZijlstra, I could not cleanly backport this to |
|
GH-124727 is a backport of this pull request to the 3.13 branch. |
JelleZijlstra
added a commit
to JelleZijlstra/cpython
that referenced
this pull request
Sep 28, 2024
- Move "versionchanged" notes that apply to the whole class to the end of the class docs - Remove or move notes next to the method list that apply to individual methods. - Mark up parameters using the appropriate syntax - Do not capitalize "boolean" - Shorten some text (cherry picked from commit c976d78) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
|
GH-124728 is a backport of this pull request to the 3.12 branch. |
JelleZijlstra
added a commit
that referenced
this pull request
Sep 28, 2024
- Move "versionchanged" notes that apply to the whole class to the end of the class docs - Remove or move notes next to the method list that apply to individual methods. - Mark up parameters using the appropriate syntax - Do not capitalize "boolean" - Shorten some text (cherry picked from commit c976d78)
Yhg1s
pushed a commit
that referenced
this pull request
Sep 30, 2024
docs: improve venv docs (GH-124540) - Move "versionchanged" notes that apply to the whole class to the end of the class docs - Remove or move notes next to the method list that apply to individual methods. - Mark up parameters using the appropriate syntax - Do not capitalize "boolean" - Shorten some text (cherry picked from commit c976d78) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
end of the class docs
methods.
📚 Documentation preview 📚: https://cpython-previews--124540.org.readthedocs.build/