Commit 3e1c8237 authored by Berker Peksag's avatar Berker Peksag

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

Patch by Éric Araujo.
parent a50afa38
...@@ -72,6 +72,9 @@ The :mod:`runpy` module provides two functions: ...@@ -72,6 +72,9 @@ The :mod:`runpy` module provides two functions:
arguments. It is recommended that the :mod:`sys` module be left alone when arguments. It is recommended that the :mod:`sys` module be left alone when
invoking this function from threaded code. invoking this function from threaded code.
.. seealso::
The :option:`-m` option offering equivalent functionality from the
command line.
.. versionchanged:: 2.7 .. versionchanged:: 2.7
Added ability to execute packages by looking for a ``__main__`` Added ability to execute packages by looking for a ``__main__``
...@@ -134,14 +137,18 @@ The :mod:`runpy` module provides two functions: ...@@ -134,14 +137,18 @@ The :mod:`runpy` module provides two functions:
limitations still apply, use of this function in threaded code should be limitations still apply, use of this function in threaded code should be
either serialised with the import lock or delegated to a separate process. 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 .. versionadded:: 2.7
.. seealso:: .. seealso::
:pep:`338` - Executing modules as scripts :pep:`338` -- Executing modules as scripts
PEP written and implemented by Nick Coghlan. 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 written and implemented by Nick Coghlan.
:ref:`using-on-general` - CPython command line details :ref:`using-on-general` - CPython command line details
...@@ -62,6 +62,8 @@ When a script file is used, it is sometimes useful to be able to run the script ...@@ -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` and enter interactive mode afterwards. This can be done by passing :option:`-i`
before the script. before the script.
All command-line options are described in :ref:`using-on-general`.
.. _tut-argpassing: .. _tut-argpassing:
......
.. highlightlang:: none .. highlightlang:: sh
.. ATTENTION: You probably should update Misc/python.man, too, if you modify .. ATTENTION: You probably should update Misc/python.man, too, if you modify
.. this file. this file.
.. _using-on-general: .. _using-on-general:
...@@ -130,6 +130,10 @@ source. ...@@ -130,6 +130,10 @@ source.
``"-"`` and the current directory will be added to the start of ``"-"`` and the current directory will be added to the start of
:data:`sys.path`. :data:`sys.path`.
.. seealso::
:func:`runpy.run_path`
Equivalent functionality directly available to Python code
.. describe:: <script> .. describe:: <script>
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment