Docs for pkgutil.get_data inconsistent with semantics

Open
#69,517 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Start by reading the current documentation for the pkgutil.get_data entry point and the linked BPO issue 25330. Compare the documented behavior with the stated semantics before deciding what needs changing; done means the documentation accurately describes the behavior, but the issue does not specify the expected wording or a test location.

Written by the indexing model from the issue text.

Description

3.7 (EOL) stdlib
BPO 25330
Nosy @Yhg1s, @anntzer, @pganssle

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 2015-10-07.03:06:14.291>
labels = ['3.7', 'library']
title = 'Docs for pkgutil.get_data inconsistent with semantics'
updated_at = <Date 2020-09-11.22:09:18.404>
user = 'https://github.com/anntzer'

bugs.python.org fields:

activity = <Date 2020-09-11.22:09:18.404>
actor = 'brett.cannon'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = ['Library (Lib)']
creation = <Date 2015-10-07.03:06:14.291>
creator = 'Antony.Lee'
dependencies = []
files = []
hgrepos = []
issue_num = 25330
keywords = []
message_count = 6.0
messages = ['252450', '252480', '263243', '263268', '310777', '310879']
nosy_count = 4.0
nosy_names = ['twouters', 'Antony.Lee', 'WGH', 'p-ganssle']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue25330'
versions = ['Python 3.6', 'Python 3.7']

Dominant language
Python
Stars
77.2k
Forks
36k
Avg merge
1d 9h
Merged PRs (30d)
558

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from python/cpython

All issues in python/cpython

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.