Skip to content

Commit 9f2b308

Browse files
*file_path* -> *path_name* in runpy.rst
The documentation for runpy.run_path refers to a parameter called *file_path*, which doesn't exist in the call spec. However, *path_name* exists, and it is implied that *file_path* actually refers to *path_name*.
1 parent 7a014f4 commit 9f2b308

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

Doc/library/runpy.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ The :mod:`!runpy` module provides two functions:
106106

107107
Execute the code at the named filesystem location and return the resulting
108108
module's globals dictionary. As with a script name supplied to the CPython
109-
command line, *file_path* may refer to a Python source file, a
109+
command line, *path_name* may refer to a Python source file, a
110110
compiled bytecode file or a valid :data:`sys.path` entry containing a
111111
:mod:`__main__` module
112112
(e.g. a zipfile containing a top-level :file:`__main__.py` file).
@@ -134,20 +134,20 @@ The :mod:`!runpy` module provides two functions:
134134
``__name__`` is set to *run_name* if this optional argument is not
135135
:const:`None` and to ``'<run_path>'`` otherwise.
136136

137-
If *file_path* directly references a script file (whether as source
137+
If *path_name* directly references a script file (whether as source
138138
or as precompiled byte code), then ``__file__`` will be set to
139-
*file_path*, and ``__spec__``, ``__loader__`` and
139+
*path_name*, and ``__spec__``, ``__loader__`` and
140140
``__package__`` will all be set to :const:`None`.
141141

142-
If *file_path* is a reference to a valid :data:`sys.path` entry, then
142+
If *path_name* is a reference to a valid :data:`sys.path` entry, then
143143
``__spec__`` will be set appropriately for the imported :mod:`__main__`
144144
module (that is, ``__spec__.name`` will always be ``__main__``).
145145
``__file__``, ``__loader__`` and ``__package__`` will be
146146
:ref:`set as normal <import-mod-attrs>` based on the module spec.
147147

148148
A number of alterations are also made to the :mod:`sys` module. Firstly,
149149
:data:`sys.path` may be altered as described above. ``sys.argv[0]`` is updated
150-
with the value of *file_path* and ``sys.modules[__name__]`` is updated
150+
with the value of *path_name* and ``sys.modules[__name__]`` is updated
151151
with a temporary module object for the module being executed. All
152152
modifications to items in :mod:`sys` are reverted before the function
153153
returns.

0 commit comments

Comments
 (0)