python / python/cpython

Automate adding Type Annotations to Documentation

Open
#83,385 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

3.9 (EOL) stdlib type-feature
Dominant language
Python
Stars
77.2k
Forks
36k
PR merge metrics
PR metrics pending

Description

BPO 39204
Nosy @gvanrossum, @brettcannon, @rhettinger, @ilevkivskyi, @cooperlees, @pablogsal, @tirkarthi

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 2020-01-03.19:12:25.475>
labels = ['type-feature', 'library', '3.9']
title = 'Automate adding Type Annotations to Documentation'
updated_at = <Date 2020-01-10.18:56:07.158>
user = 'https://github.com/cooperlees'

bugs.python.org fields:

activity = <Date 2020-01-10.18:56:07.158>
actor = 'levkivskyi'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = ['Library (Lib)']
creation = <Date 2020-01-03.19:12:25.475>
creator = 'cooperlees'
dependencies = []
files = []
hgrepos = []
issue_num = 39204
keywords = []
message_count = 6.0
messages = ['359249', '359274', '359275', '359276', '359446', '359449']
nosy_count = 7.0
nosy_names = ['gvanrossum', 'brett.cannon', 'rhettinger', 'levkivskyi', 'cooperlees', 'pablogsal', 'xtreak']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue39204'
versions = ['Python 3.9']

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

No source files, tests, or entry points are identified in the issue. Start by reviewing the linked BPO issue and the Python library documentation workflow to define how annotations should be discovered and rendered; done means the process adds type annotations to the documentation automatically.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.