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

Created on 2016-04-18 01:55 by Antony.Lee, last changed 2018-02-27 04:24 by abrezovsky.

Pull Requests
URL Status Linked Edit
PR 5921 open abrezovsky, 2018-02-27 04:24
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 __main__.py 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.
History
Date User Action Args
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