python / python/cpython

Automatically tabulate module contents in the docs

Open
#83,545 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

3.7 (EOL) 3.8 (EOL) 3.9 (EOL) docs type-feature
Dominant language
Python
Stars
77.2k
Forks
36k
Avg merge
1d 9h
Merged PRs (30d)
558

Description

BPO 39364
Nosy @JulienPalard, @alexchandel

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-16.22:05:46.796>
labels = ['3.8', 'type-feature', '3.7', '3.9', 'docs']
title = 'Automatically tabulate module contents in the docs'
updated_at = <Date 2020-01-17.08:13:58.250>
user = 'https://github.com/alexchandel'

bugs.python.org fields:

activity = <Date 2020-01-17.08:13:58.250>
actor = 'xtreak'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2020-01-16.22:05:46.796>
creator = 'alexchandel'
dependencies = []
files = []
hgrepos = []
issue_num = 39364
keywords = []
message_count = 1.0
messages = ['360148']
nosy_count = 3.0
nosy_names = ['docs@python', 'mdk', 'alexchandel']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue39364'
versions = ['Python 2.7', 'Python 3.5', 'Python 3.6', 'Python 3.7', 'Python 3.8', '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 files, tests, or entry points are named. Start by reading the linked BPO issue 39364 and the CPython documentation context; done means module contents are automatically tabulated in the documentation, with the intended scope clarified before implementation.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.