python / python/cpython

Move documentation for typed generic forms of standard collections to collections.abc

Open
#89,515 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

3.11 docs topic-typing type-feature
Dominant language
Python
Stars
77.2k
Forks
36k
PR merge metrics
PR metrics pending

Description

BPO 45352
Nosy @gvanrossum, @rhettinger, @pxeger, @Fidget-Spinner

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-10-03.13:12:33.140>
labels = ['3.11', 'type-feature', 'docs']
title = 'Move documentation for typed generic forms of standard collections to collections.abc'
updated_at = <Date 2021-10-08.20:33:32.869>
user = 'https://github.com/pxeger'

bugs.python.org fields:

activity = <Date 2021-10-08.20:33:32.869>
actor = 'terry.reedy'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2021-10-03.13:12:33.140>
creator = 'pxeger'
dependencies = []
files = []
hgrepos = []
issue_num = 45352
keywords = []
message_count = 6.0
messages = ['403085', '403092', '403104', '403107', '403135', '403144']
nosy_count = 6.0
nosy_names = ['gvanrossum', 'rhettinger', 'stutzbach', 'docs@python', 'pxeger', 'kj']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'needs patch'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue45352'
versions = ['Python 3.11']

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

The issue names no file or test; start by locating the documentation for standard collections and collections.abc, then compare where typed generic forms are described. Move the relevant documentation to collections.abc and verify the documentation build.

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
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.