From: Berker Peksag <berker.peksag@gmail.com>
Date: Wed, 10 Dec 2014 00:07:08 +0000 (+0200)
Subject: Issue #12602: Add missing cross-references to runpy and using/cmdline docs.
X-Git-Tag: v2.7.10rc1~284
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=3e1c8237e8f4901deba15e04af5ca18ba4fed720;p=python

Issue #12602: Add missing cross-references to runpy and using/cmdline docs.

Patch by Éric Araujo.
---

diff --git a/Doc/library/runpy.rst b/Doc/library/runpy.rst
index fc9e7c1488..a08bc940e7 100644
--- a/Doc/library/runpy.rst
+++ b/Doc/library/runpy.rst
@@ -72,6 +72,9 @@ The :mod:`runpy` module provides two functions:
    arguments. It is recommended that the :mod:`sys` module be left alone when
    invoking this function from threaded code.
 
+   .. seealso::
+      The :option:`-m` option offering equivalent functionality from the
+      command line.
 
    .. versionchanged:: 2.7
          Added ability to execute packages by looking for a ``__main__``
@@ -134,14 +137,18 @@ The :mod:`runpy` module provides two functions:
    limitations still apply, use of this function in threaded code should be
    either serialised with the import lock or delegated to a separate process.
 
+   .. seealso::
+      :ref:`using-on-interface-options` for equivalent functionality on the
+      command line (``python path/to/script``).
+
    .. versionadded:: 2.7
 
 .. seealso::
 
-   :pep:`338` - Executing modules as scripts
+   :pep:`338` -- Executing modules as scripts
       PEP written and implemented by Nick Coghlan.
 
-   :pep:`366` - Main module explicit relative imports
+   :pep:`366` -- Main module explicit relative imports
       PEP written and implemented by Nick Coghlan.
 
    :ref:`using-on-general` - CPython command line details
diff --git a/Doc/tutorial/interpreter.rst b/Doc/tutorial/interpreter.rst
index 514c5f1986..19094f3e2a 100644
--- a/Doc/tutorial/interpreter.rst
+++ b/Doc/tutorial/interpreter.rst
@@ -62,6 +62,8 @@ When a script file is used, it is sometimes useful to be able to run the script
 and enter interactive mode afterwards.  This can be done by passing :option:`-i`
 before the script.
 
+All command-line options are described in :ref:`using-on-general`.
+
 
 .. _tut-argpassing:
 
diff --git a/Doc/using/cmdline.rst b/Doc/using/cmdline.rst
index b657f3f17c..ce5e76fd4c 100644
--- a/Doc/using/cmdline.rst
+++ b/Doc/using/cmdline.rst
@@ -1,7 +1,7 @@
-.. highlightlang:: none
+.. highlightlang:: sh
 
 .. ATTENTION: You probably should update Misc/python.man, too, if you modify
-.. this file.
+   this file.
 
 .. _using-on-general:
 
@@ -130,6 +130,10 @@ source.
    ``"-"`` and the current directory will be added to the start of
    :data:`sys.path`.
 
+   .. seealso::
+      :func:`runpy.run_path`
+         Equivalent functionality directly available to Python code
+
 
 .. describe:: <script>