bpo-33095: Add reference to isolated mode in -m and script option by tirkarthi · Pull Request #7764 · python/cpython

tirkarthi · 2018-06-17T13:42:55Z

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

zooba · 2018-07-28T12:53:07Z

Doc/using/cmdline.rst

   .. versionchanged:: 3.4
      namespace packages are also supported

+.. _cmdarg-dash:


Is it possible the : at the end of the name is not necessary and that is what's affecting the font?

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

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.

vstinner · 2019-01-10T16:02:26Z

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

Doc/using/cmdline.rst

bedevere-bot · 2019-09-10T15:07:53Z

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.

Co-Authored-By: Julien Palard <[email protected]>

tirkarthi · 2019-09-13T16:13:34Z

I have made the requested changes; please review again

bedevere-bot · 2019-09-13T16:13:36Z

Thanks for making the requested changes!

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

miss-islington · 2019-09-14T00:35:47Z

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

miss-islington · 2019-09-14T00:35:54Z

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 · 2019-09-16T12:14:15Z

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 <[email protected]> (cherry picked from commit bdd6945) Co-authored-by: Xtreak <[email protected]>

bedevere-bot · 2019-09-16T12:14:23Z

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

bedevere-bot · 2019-09-16T12:20:27Z

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

…-7764) Attempt to make isolated mode easier to discover via additional inline documentation. Co-Authored-By: Julien Palard <[email protected]> (cherry picked from commit bdd6945) Co-authored-by: Xtreak <[email protected]>

…on (GH-7764) (GH-16181) Attempt to make isolated mode easier to discover via additional inline documentation. Co-Authored-By: Julien Palard <[email protected]>. (cherry picked from commit bdd6945) Co-authored-by: Xtreak <[email protected]>

JulienPalard · 2019-09-16T14:11:11Z

Thanks @tirkarthi!

the-knights-who-say-ni added the CLA signed label Jun 17, 2018

bedevere-bot added the awaiting review label Jun 17, 2018

zooba added needs backport to 3.6 skip news labels Jul 28, 2018

zooba reviewed Jul 28, 2018

View reviewed changes

serhiy-storchaka added the docs Documentation in the Doc dir label Dec 8, 2018

vstinner removed the needs backport to 3.6 label Jan 10, 2019

csabella requested a review from zooba May 18, 2019 12:02

JulienPalard requested changes Sep 10, 2019

View reviewed changes

Doc/using/cmdline.rst Outdated Show resolved Hide resolved

bedevere-bot added awaiting changes and removed awaiting review labels Sep 10, 2019

tirkarthi and others added 2 commits September 13, 2019 11:22

Add reference to isolated mode in -m and script option

ad2110c

Update Doc/using/cmdline.rst

fb30aa1

Co-Authored-By: Julien Palard <[email protected]>

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

bedevere-bot added awaiting change review and removed awaiting changes labels Sep 13, 2019

bedevere-bot requested a review from JulienPalard September 13, 2019 16:13

ncoghlan approved these changes Sep 14, 2019

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting change review labels Sep 14, 2019

ncoghlan merged commit bdd6945 into python:master Sep 14, 2019

bedevere-bot removed the awaiting merge label Sep 14, 2019

miss-islington assigned ncoghlan Sep 14, 2019

JulienPalard added the needs backport to 3.8 label Sep 16, 2019

bedevere-bot removed the needs backport to 3.8 label Sep 16, 2019

bedevere-bot removed the needs backport to 3.7 label Sep 16, 2019

Uh oh!

Conversation

tirkarthi commented Jun 17, 2018 • edited by bedevere-bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

zooba Jul 28, 2018

Choose a reason for hiding this comment

Uh oh!

tirkarthi Jul 28, 2018

Choose a reason for hiding this comment

Uh oh!

tirkarthi Jul 28, 2018

Choose a reason for hiding this comment

Uh oh!

vstinner commented Jan 10, 2019

Uh oh!

Uh oh!

bedevere-bot commented Sep 10, 2019

Uh oh!

tirkarthi commented Sep 13, 2019

Uh oh!

bedevere-bot commented Sep 13, 2019

Uh oh!

miss-islington commented Sep 14, 2019

Uh oh!

miss-islington commented Sep 14, 2019

Uh oh!

miss-islington commented Sep 16, 2019

Uh oh!

bedevere-bot commented Sep 16, 2019

Uh oh!

bedevere-bot commented Sep 16, 2019

Uh oh!

JulienPalard commented Sep 16, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

tirkarthi commented Jun 17, 2018 •

edited by bedevere-bot

Loading