summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorBerker Peksag <berker.peksag@gmail.com>2014-12-09 23:47:50 (GMT)
committerBerker Peksag <berker.peksag@gmail.com>2014-12-09 23:47:50 (GMT)
commit0ecd7ba9681f8ff413fdf88cf932e6c37a69ae34 (patch)
tree0e942e64a7d8da6fc8bb515665bc64684369360f /Doc
parentbd8d68cdc19f55a177440bfbd1a0473a00c75f77 (diff)
parent8b1cbd2b7cd8752462c68b17447446b54065691c (diff)
downloadcpython-0ecd7ba9681f8ff413fdf88cf932e6c37a69ae34.zip
cpython-0ecd7ba9681f8ff413fdf88cf932e6c37a69ae34.tar.gz
cpython-0ecd7ba9681f8ff413fdf88cf932e6c37a69ae34.tar.bz2
Issue #12602: Add missing cross-references to runpy and using/cmdline docs.
Patch by Éric Araujo.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/runpy.rst13
-rw-r--r--Doc/tutorial/interpreter.rst2
-rw-r--r--Doc/using/cmdline.rst12
3 files changed, 20 insertions, 7 deletions
diff --git a/Doc/library/runpy.rst b/Doc/library/runpy.rst
index db1db3e..7293f15 100644
--- a/Doc/library/runpy.rst
+++ b/Doc/library/runpy.rst
@@ -75,6 +75,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:: 3.1
Added ability to execute packages by looking for a ``__main__`` submodule.
@@ -146,6 +149,10 @@ 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:: 3.2
.. versionchanged:: 3.4
@@ -156,13 +163,13 @@ The :mod:`runpy` module provides two functions:
.. 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.
- :pep:`451` - A ModuleSpec Type for the Import System
+ :pep:`451` -- A ModuleSpec Type for the Import System
PEP written and implemented by Eric Snow
:ref:`using-on-general` - CPython command line details
diff --git a/Doc/tutorial/interpreter.rst b/Doc/tutorial/interpreter.rst
index 6cd3ecd..d5789a6 100644
--- a/Doc/tutorial/interpreter.rst
+++ b/Doc/tutorial/interpreter.rst
@@ -63,6 +63,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 3749e74..4017ce8 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:
@@ -148,6 +148,10 @@ source.
added to the start of :data:`sys.path` and the ``__main__.py`` file in
that location is executed as the :mod:`__main__` module.
+ .. seealso::
+ :func:`runpy.run_path`
+ Equivalent functionality directly available to Python code
+
If no interface option is given, :option:`-i` is implied, ``sys.argv[0]`` is
an empty string (``""``) and the current directory will be added to the
@@ -155,11 +159,11 @@ start of :data:`sys.path`. Also, tab-completion and history editing is
automatically enabled, if available on your platform (see
:ref:`rlcompleter-config`).
+.. seealso:: :ref:`tut-invoking`
+
.. versionchanged:: 3.4
Automatic enabling of tab-completion and history editing.
-.. seealso:: :ref:`tut-invoking`
-
Generic options
~~~~~~~~~~~~~~~