Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Closed
anntzer mannequin opened this issue Apr 18, 2016 · 4 comments
Closed

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

anntzer mannequin opened this issue Apr 18, 2016 · 4 comments
Labels
3.7 (EOL) end of life 3.8 only security fixes docs Documentation in the Doc dir easy type-feature A feature request or enhancement

Comments

@anntzer
Copy link
Mannequin

anntzer mannequin commented Apr 18, 2016

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
    Copy link
    Mannequin Author

    anntzer mannequin commented Apr 18, 2016 

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

    @anntzer anntzer mannequin assigned docspython Apr 18, 2016
    @anntzer anntzer mannequin added the docs Documentation in the Doc dir label Apr 18, 2016
    @csabella csabella added easy 3.7 (EOL) end of life 3.8 only security fixes type-feature A feature request or enhancement labels Feb 22, 2018
    @abrezovsky
    Copy link
    Mannequin

    abrezovsky mannequin commented Feb 27, 2018

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

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    @JelleZijlstra JelleZijlstra mentioned this issue Apr 14, 2022
    Merged
    JelleZijlstra added a commit that referenced this issue Apr 15, 2022
    @JelleZijlstra
    gh-70979: Fix runpy.run_path parameter name in docs (GH-32265)
    f1e989b 
    Noticed while reviewing GH-30729.
    miss-islington pushed a commit to miss-islington/cpython that referenced this issue Apr 15, 2022
    @JelleZijlstra @miss-islington
    pythongh-70979: Fix runpy.run_path parameter name in docs (pythonGH-3…
    1675f14 
    …2265)

Noticed while reviewing pythonGH-30729.
(cherry picked from commit f1e989b)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
    miss-islington added a commit that referenced this issue Apr 15, 2022
    @miss-islington @JelleZijlstra
    gh-70979: Fix runpy.run_path parameter name in docs (GH-32265)
    de7b756 
    Noticed while reviewing GH-30729.
(cherry picked from commit f1e989b)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
    miss-islington added a commit that referenced this issue Apr 15, 2022
    @miss-islington @JelleZijlstra
    gh-70979: Fix runpy.run_path parameter name in docs (GH-32265)
    b32d124 
    Noticed while reviewing GH-30729.
(cherry picked from commit f1e989b)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
    hello-adam pushed a commit to hello-adam/cpython that referenced this issue Jun 2, 2022
    @miss-islington @JelleZijlstra @hello-adam
    pythongh-70979: Fix runpy.run_path parameter name in docs (pythonGH-3…
    a5caf1a 
    …2265)

Noticed while reviewing pythonGH-30729.
(cherry picked from commit f1e989b)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
    @furkanonder
    Copy link
    Contributor

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

    @JelleZijlstra
    Copy link
    Member

    Thanks!

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees
    No one assigned
    Labels
    3.7 (EOL) end of life 3.8 only security fixes docs Documentation in the Doc dir easy type-feature A feature request or enhancement
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    3 participants
    @JelleZijlstra @furkanonder @csabella