python / python/cpython

Need reST markup for enum types

Open
#73,787 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs
Dominant language
Python
Stars
77.2k
Forks
36k
PR merge metrics
PR metrics pending

Description

BPO 29601
Nosy @freddrake, @warsaw, @berkerpeksag

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 2017-02-19.17:08:14.768>
labels = ['3.7', 'docs']
title = 'Need reST markup for enum types'
updated_at = <Date 2017-02-20.00:13:44.715>
user = 'https://github.com/warsaw'

bugs.python.org fields:

activity = <Date 2017-02-20.00:13:44.715>
actor = 'barry'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2017-02-19.17:08:14.768>
creator = 'barry'
dependencies = []
files = []
hgrepos = []
issue_num = 29601
keywords = []
message_count = 3.0
messages = ['288147', '288167', '288168']
nosy_count = 4.0
nosy_names = ['fdrake', 'barry', 'docs@python', 'berker.peksag']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue29601'
versions = ['Python 3.7']

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 identifies Python documentation and requests reST markup for enum types, but names no file or test. Start by reviewing the linked BPO issue and searching the documentation for enum type references. Done means the affected documentation uses the requested reST markup and the relevant documentation checks succeed.

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
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.