[Python-checkins] gh-70979: Fix runpy.run_path parameter name in docs (GH-32265)
JelleZijlstra
webhook-mailer at python.org
Thu Apr 14 21:07:03 EDT 2022
https://github.com/python/cpython/commit/f1e989b04507db6f0adbccb5e1624d81cb217ea8
commit: f1e989b04507db6f0adbccb5e1624d81cb217ea8
branch: main
author: Jelle Zijlstra <jelle.zijlstra at gmail.com>
committer: JelleZijlstra <jelle.zijlstra at gmail.com>
date: 2022-04-14T18:06:58-07:00
summary:
gh-70979: Fix runpy.run_path parameter name in docs (GH-32265)
Noticed while reviewing GH-30729.
files:
M Doc/library/runpy.rst
diff --git a/Doc/library/runpy.rst b/Doc/library/runpy.rst
index af35e81a2d452..26a4f1435214e 100644
--- a/Doc/library/runpy.rst
+++ b/Doc/library/runpy.rst
@@ -93,7 +93,7 @@ The :mod:`runpy` module provides two functions:
run this way, as well as ensuring the real module name is always
accessible as ``__spec__.name``.
-.. function:: run_path(file_path, init_globals=None, run_name=None)
+.. function:: run_path(path_name, init_globals=None, run_name=None)
.. index::
module: __main__
@@ -140,7 +140,7 @@ The :mod:`runpy` module provides two functions:
A number of alterations are also made to the :mod:`sys` module. Firstly,
``sys.path`` may be altered as described above. ``sys.argv[0]`` is updated
- with the value of ``file_path`` and ``sys.modules[__name__]`` is updated
+ with the value of ``path_name`` and ``sys.modules[__name__]`` is updated
with a temporary module object for the module being executed. All
modifications to items in :mod:`sys` are reverted before the function
returns.
More information about the Python-checkins
mailing list