docstrings of runpy.run_{module,path} are rather sparse

[anntzer]

BPO	26792
Nosy	@JelleZijlstra, @abrezovsky, @humbdrag
PRs	bpo-26792: improve docstrings of runpy module run_ functions #5921 bpo-26792: Improve docstrings of runpy module run_functions #30729 gh-70979: Fix runpy.run_path parameter name in docs #32265

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2016-04-18.01:55:02.470>
labels = ['easy', '3.8', 'type-feature', '3.7', 'docs']
title = 'docstrings of runpy.run_{module,path} are rather sparse'
updated_at = <Date 2022-04-03.16:13:37.392>
user = 'https://github.com/anntzer'

bugs.python.org fields:

activity = <Date 2022-04-03.16:13:37.392>
actor = 'Antony.Lee'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2016-04-18.01:55:02.470>
creator = 'Antony.Lee'
dependencies = []
files = []
hgrepos = []
issue_num = 26792
keywords = ['patch', 'easy']
message_count = 2.0
messages = ['263638', '312980']
nosy_count = 4.0
nosy_names = ['docs@python', 'JelleZijlstra', 'abrezovsky', 'humbdrag']
pr_nums = ['5921', '30729', '32265']
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue26792'
versions = ['Python 3.7', 'Python 3.8']

[anntzer]

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

[abrezovsky]

I'll update these based on the information in the HTML docs.

[furkanonder]

@JelleZijlstra The issue seems to be resolved with the merged PRs. I think the issue can be closed.

[JelleZijlstra]

Thanks!