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

Cover directory and zipfile execution in __main__ module docs #89312

Open
ncoghlan opened this issue Sep 9, 2021 · 1 comment
Open

Cover directory and zipfile execution in __main__ module docs #89312

ncoghlan opened this issue Sep 9, 2021 · 1 comment
Labels
docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@ncoghlan
Copy link
Contributor

ncoghlan commented Sep 9, 2021

BPO 45149
Nosy @ncoghlan

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 2021-09-09.07:45:42.475>
labels = ['type-feature', 'docs']
title = 'Cover directory and zipfile execution in __main__ module docs'
updated_at = <Date 2022-03-11.14:52:45.711>
user = 'https://github.com/ncoghlan'

bugs.python.org fields:

activity = <Date 2022-03-11.14:52:45.711>
actor = 'petr.viktorin'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2021-09-09.07:45:42.475>
creator = 'ncoghlan'
dependencies = []
files = []
hgrepos = []
issue_num = 45149
keywords = []
message_count = 1.0
messages = ['401440']
nosy_count = 2.0
nosy_names = ['ncoghlan', 'docs@python']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'needs patch'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue45149'
versions = []
@ncoghlan
Copy link
Contributor Author

ncoghlan commented Sep 9, 2021

bpo-39452 covered significant improvements to the __main__ module documentation at https://docs.python.org/dev/library/__main__.html, making it a better complement to the CPython CLI documentation at https://docs.python.org/dev/using/cmdline.html#command-line

This follow up ticket covers the __main__ variant that the previous ticket didn't cover: directory and zipfile execution (which underlies the utility of the zipapp stdlib module: https://docs.python.org/dev/library/zipapp.html)

The relevant info is present in the CLI and runpy.run_path documentation, so this ticket just covers adding that info to the __main__ module docs.

@ncoghlan ncoghlan added type-feature A feature request or enhancement labels Sep 9, 2021
@encukou encukou added the docs Documentation in the Doc dir label Mar 11, 2022
@encukou encukou added the docs Documentation in the Doc dir label Mar 11, 2022
@ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation in the Doc dir type-feature A feature request or enhancement
Projects
Zipfile issues
Status: No status
Milestone
No milestone
Development

No branches or pull requests
2 participants
@encukou @ncoghlan