Cover directory and zipfile execution in __main__ module docs
Open
Nobody has claimed this yet.
docs
type-feature
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 36k
- PR merge metrics
- PR metrics pending
Description
| 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 = []
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the main module documentation and review how execution from directories and zipfiles is currently described. Update the documentation to cover both execution forms, then verify that the resulting text clearly explains them; no specific file or test is named in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100