python / python/cpython

Documentation for handling of non-type metaclass hints is unclear

Open
#72,623 14 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs stdlib type-bug
Dominant language
Python
Stars
77.2k
Forks
36k
PR merge metrics
PR metrics pending

Description

BPO 28437
Nosy @ncoghlan, @NeilGirdhar

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-10-13.23:50:59.803>
labels = ['type-bug', 'library', 'docs']
title = 'Documentation for handling of non-type metaclass hints is unclear'
updated_at = <Date 2016-10-16.07:49:51.930>
user = 'https://github.com/NeilGirdhar'

bugs.python.org fields:

activity = <Date 2016-10-16.07:49:51.930>
actor = 'ncoghlan'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation', 'Library (Lib)']
creation = <Date 2016-10-13.23:50:59.803>
creator = 'NeilGirdhar'
dependencies = []
files = []
hgrepos = []
issue_num = 28437
keywords = []
message_count = 14.0
messages = ['278625', '278627', '278704', '278705', '278706', '278727', '278728', '278729', '278743', '278744', '278745', '278746', '278747', '278748']
nosy_count = 3.0
nosy_names = ['ncoghlan', 'docs@python', 'NeilGirdhar']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue28437'
versions = ['Python 3.6']

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.

Research direction

Start by reading the linked BPO issue 28437 and its discussion about non-type metaclass hints. Locate the relevant Python library documentation, then clarify the handling described by the issue title and verify that the resulting wording matches the intended behavior.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.