Sorry, something went wrong.
There was a problem hiding this comment.
This PR adjusts reStructuredText section adornments in the virtualenv documentation, intending to change subsection heading formatting.
Changes:
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sorry, something went wrong.
|
Thanks for the review! Should I revert Basic Usage back to ~~~ and only change Other useful commands? Or use a different character like ^ for subsections? Please advise.
________________________________
From: Copilot ***@***.***>
Sent: Monday, April 20, 2026 2:57 AM
To: realpython/python-guide ***@***.***>
Cc: SIDRA MARYAM ***@***.***>; Author ***@***.***>
Subject: Re: [realpython/python-guide] Update virtualenvs.rst (PR #1183)
@Copilot commented on this pull request.
Pull request overview
This PR adjusts reStructuredText section adornments in the virtualenv documentation, intending to change subsection heading formatting.
Changes:
* Replaced ~ subsection underlines with - underlines for two headings in docs/dev/virtualenvs.rst.
________________________________
💡 Add Copilot custom instructions</realpython/python-guide/new/master?filename=.github/instructions/*.instructions.md> for smarter, more guided reviews. Learn how to get started<https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot>.
________________________________
In docs/dev/virtualenvs.rst<#1183?email_source=notifications&email_token=BYPSMEWPWI4MSIE4CUUQTDD4WXYCBA5CNFSNUABKM5UWIORPF5TWS5BNNB2WEL2QOVWGYUTFOF2WK43UKJSXM2LFO4XTIMJTHA4TSMZQG43KM4TFMFZW63VGMF2XI2DPOKSWK5TFNZ2K64DSL5ZGK5TJMV3V6Y3MNFRWW#discussion_r3109788342>:
@@ -360,7 +360,7 @@ To install (make sure **virtualenv** is already installed):
In Windows, the default path for WORKON_HOME is %USERPROFILE%\\Envs
Basic Usage
-~~~~~~~~~~~
+-----------
Changing the subsection underline from "" to "-" makes "Basic Usage" a same-level section as "virtualenvwrapper" (both now use "-") rather than a subsection under it. This alters the document structure/TOC; consider keeping a distinct adornment for this heading level (e.g., revert to "" or use another character consistently for subsections).
________________________________
In docs/dev/virtualenvs.rst<#1183?email_source=notifications&email_token=BYPSMEWPWI4MSIE4CUUQTDD4WXYCBA5CNFSNUABKM5UWIORPF5TWS5BNNB2WEL2QOVWGYUTFOF2WK43UKJSXM2LFO4XTIMJTHA4TSMZQG43KM4TFMFZW63VGMF2XI2DPOKSWK5TFNZ2K64DSL5ZGK5TJMV3V6Y3MNFRWW#discussion_r3109788375>:
@@ -404,7 +404,7 @@ can quickly switch between environments.
$ rmvirtualenv venv
Other useful commands
-~~~~~~~~~~~~~~~~~~~~~
+---------------------
Using "-" for this underline makes "Other useful commands" a peer section to "virtualenvwrapper" instead of a subsection (since "virtualenvwrapper" also uses "-"). If this is intended to remain a subsection under "virtualenvwrapper", use a different, consistent subsection adornment character (as used elsewhere in the docs) to preserve hierarchy.
—
Reply to this email directly, view it on GitHub<#1183?email_source=notifications&email_token=BYPSMETA5UDMTPA6N5JXU534WXYCBA5CNFSNUABKM5UWIORPF5TWS5BNNB2WEL2QOVWGYUTFOF2WK43UKJSXM2LFO4XTIMJTHA4TSMZQG43KM4TFMFZW63VGMF2XI2DPOKSWK5TFNZ2L24DSL5ZGK5TJMV3V63TPORUWM2LDMF2GS33OONPWG3DJMNVQ#pullrequestreview-4138993076>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/BYPSMEVOXZ6ZRXIE3RXTHHL4WXYCBAVCNFSM6AAAAACX7LUP66VHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHM2DCMZYHE4TGMBXGY>.
You are receiving this because you authored the thread.Message ID: ***@***.***>
|
Sorry, something went wrong.
.