Skip to content
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

Merged
merged 2 commits into from
Sep 14, 2019

Conversation

tirkarthi
Copy link
Member

@tirkarthi tirkarthi commented Jun 17, 2018

  • Add reference to isolated mode in -m and <script> option
  • Make - 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 knowledge

Ref for hyperlinking : https://bugs.python.org/msg319812

https://bugs.python.org/issue33095

Thanks

https://bugs.python.org/issue33095

@@ -119,6 +124,7 @@ source.
.. versionchanged:: 3.4
namespace packages are also supported

.. _cmdarg-dash:
Copy link
Member

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?

Copy link
Member Author

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

Copy link
Member Author

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.

@serhiy-storchaka serhiy-storchaka added the docs Documentation in the Doc dir label Dec 8, 2018
@vstinner
Copy link
Member

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

@csabella csabella requested a review from zooba May 18, 2019 12:02
Doc/using/cmdline.rst Outdated Show resolved Hide resolved
@bedevere-bot
Copy link

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 I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

@tirkarthi tirkarthi force-pushed the bpo33095-reference-isolated-mode branch from 635c472 to fb30aa1 Compare September 13, 2019 10:22
@tirkarthi
Copy link
Member Author

I have made the requested changes; please review again

@bedevere-bot
Copy link

Thanks for making the requested changes!

@JulienPalard: please review the changes made to this pull request.

@ncoghlan ncoghlan merged commit bdd6945 into python:master Sep 14, 2019
@miss-islington
Copy link
Contributor

Thanks @tirkarthi for the PR, and @ncoghlan for merging it 🌮🎉.. I'm working now to backport this PR to: 3.7.
🐍🍒⛏🤖

@miss-islington
Copy link
Contributor

Sorry, @tirkarthi and @ncoghlan, I could not cleanly backport this to 3.7 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker bdd6945d4dbd1fe6a7fcff95f7d6908db7d791a1 3.7

@miss-islington
Copy link
Contributor

Thanks @tirkarthi for the PR, and @ncoghlan for merging it 🌮🎉.. I'm working now to backport this PR to: 3.8.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 16, 2019
…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>
@bedevere-bot
Copy link

GH-16180 is a backport of this pull request to the 3.8 branch.

@bedevere-bot
Copy link

GH-16181 is a backport of this pull request to the 3.7 branch.

miss-islington added a commit that referenced this pull request Sep 16, 2019
…-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>
JulienPalard added a commit that referenced this pull request Sep 16, 2019
…on (GH-7764) (GH-16181)

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>
@JulienPalard
Copy link
Member

Thanks @tirkarthi!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants