This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Title: docstrings of runpy.run_{module,path} are rather sparse
Type: enhancement Stage: patch review
Components: Documentation Versions: Python 3.8, Python 3.7
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: JelleZijlstra, abrezovsky, docs@python, humbdrag
Priority: normal Keywords: easy, patch

Created on 2016-04-18 01:55 by Antony.Lee, last changed 2022-04-11 14:58 by admin.

Pull Requests
URL Status Linked Edit
PR 5921 closed abrezovsky, 2018-02-27 04:24
PR 30729 open humbdrag, 2022-01-20 21:48
PR 32265 open JelleZijlstra, 2022-04-02 20:17
Messages (2)
msg263638 - (view) Author: Antony Lee (Antony.Lee) * Date: 2016-04-18 01:55
$ pydoc runpy

    run_module(mod_name, init_globals=None, run_name=None, alter_sys=False)
        Execute a module's code without importing it
        Returns the resulting top level namespace dictionary
    run_path(path_name, init_globals=None, run_name=None)
        Execute code located at the specified filesystem location
        Returns the resulting top level namespace dictionary
        The file path may refer directly to a Python script (i.e.
        one that could be directly executed with execfile) or else
        it may refer to a zipfile or directory containing a top
        level script.

The meaning of the arguments should be documented (e.g. by copy-pasting the html docs).  (And some sentences are missing final dots.)
msg312980 - (view) Author: Andrew Brezovsky (abrezovsky) * Date: 2018-02-27 02:26
I'll update these based on the information in the HTML docs.
Date User Action Args
2022-04-11 14:58:29adminsetgithub: 70979
2022-04-03 16:13:37Antony.Leesetnosy: - Antony.Lee
2022-04-02 20:17:27JelleZijlstrasetnosy: + JelleZijlstra
pull_requests: + pull_request30330
2022-01-20 21:48:01humbdragsetnosy: + humbdrag
pull_requests: + pull_request28916
2018-02-27 04:24:25abrezovskysetkeywords: + patch
stage: needs patch -> patch review
pull_requests: + pull_request5692
2018-02-27 02:26:07abrezovskysetnosy: + abrezovsky
messages: + msg312980
2018-02-22 14:50:13cheryl.sabellasetkeywords: + easy
stage: needs patch
type: enhancement
versions: + Python 3.7, Python 3.8, - Python 3.5
2016-04-18 01:55:02Antony.Leecreate