-
-
Notifications
You must be signed in to change notification settings - Fork 30.2k
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
bpo-33095: Add reference to isolated mode in -m and script option #7764
bpo-33095: Add reference to isolated mode in -m and script option #7764
Conversation
@@ -119,6 +124,7 @@ source. | |||
.. versionchanged:: 3.4 | |||
namespace packages are also supported | |||
|
|||
.. _cmdarg-dash: |
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.
Is it possible the :
at the end of the name is not necessary and that is what's affecting the font?
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.
Can you be little more specific on affecting the font part? On removing :
at the end I get /home/cpython/Doc/using/cmdline.rst:127: WARNING: malformed hyperlink target.
. To be honest my knowledge on Sphinx markdown is low. I took this syntax as an exact copy from https://bugs.python.org/issue33095#msg319812 . I was trying to make them hyperlinks so that they can be referenced I might be wrong on the syntax here.
Thanks
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.
Initially I was trying out .. cmdoption:: -
and .. cmdoption:: script
removing describe::
which works fine but there was an explicit note on the bpo message to use .. _cmdarg-dash:
so that they are hyperlinkable like option ones without looking the same.
For making "-" and "<script>" hyperlinkable, you'll need to add a label definition to the Sphinx source code immediately before those description sections. I'd suggest ".. _cmdarg-dash:" and ".. _cmdarg-script:" so the resulting anchors look similar to the option ones, without being the same.
I removed the " needs backport to 3.6" label, the 3.6 branch no longer accept bugfixes (only security fixes are accepted): https://devguide.python.org/#status-of-python-branches |
A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated. Once you have made the requested changes, please leave a comment on this pull request containing the phrase |
Co-Authored-By: Julien Palard <julien@palard.fr>
635c472
to
fb30aa1
Compare
I have made the requested changes; please review again |
Thanks for making the requested changes! @JulienPalard: please review the changes made to this pull request. |
Thanks @tirkarthi for the PR, and @ncoghlan for merging it 🌮🎉.. I'm working now to backport this PR to: 3.7. |
Sorry, @tirkarthi and @ncoghlan, I could not cleanly backport this to |
Thanks @tirkarthi for the PR, and @ncoghlan for merging it 🌮🎉.. I'm working now to backport this PR to: 3.8. |
…thonGH-7764) Attempt to make isolated mode easier to discover via additional inline documentation. Co-Authored-By: Julien Palard <julien@palard.fr> (cherry picked from commit bdd6945) Co-authored-by: Xtreak <tir.karthi@gmail.com>
GH-16180 is a backport of this pull request to the 3.8 branch. |
GH-16181 is a backport of this pull request to the 3.7 branch. |
Thanks @tirkarthi! |
-m
and<script>
option-
and<script>
hyperlinkable. I couldn't get this working using label definitions in markdown. I read through cross-linking markup but it seems that adding it increases the font and makes the section as 1.2 . Maybe I am missing something here due to my limited knowledgeRef for hyperlinking : https://bugs.python.org/msg319812
https://bugs.python.org/issue33095
Thanks
https://bugs.python.org/issue33095