[New-bugs-announce] [issue26792] docstrings of runpy.run_{module, path} are rather sparse

[Antony Lee]

New submission from Antony Lee:

$ 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.)

----------
assignee: docs at python
components: Documentation
messages: 263638
nosy: Antony.Lee, docs at python
priority: normal
severity: normal
status: open
title: docstrings of runpy.run_{module,path} are rather sparse
versions: Python 3.5

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue26792>
_______________________________________