python / python/cpython

__doc__ should generally be writable

Open
#91,309 4 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

interpreter-core type-feature
Dominant language
Python
Stars
77.2k
Forks
36k
PR merge metrics
PR metrics pending

Description

BPO 47153
Nosy @warsaw, @gpshead, @pitrou, @scoder

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 2022-03-29.17:32:48.885>
labels = ['interpreter-core', 'type-feature', '3.11']
title = '__doc__ should generally be writable'
updated_at = <Date 2022-04-05.07:27:02.781>
user = 'https://github.com/pitrou'

bugs.python.org fields:

activity = <Date 2022-04-05.07:27:02.781>
actor = 'gregory.p.smith'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = ['Interpreter Core']
creation = <Date 2022-03-29.17:32:48.885>
creator = 'pitrou'
dependencies = []
files = []
hgrepos = []
issue_num = 47153
keywords = []
message_count = 1.0
messages = ['416277']
nosy_count = 4.0
nosy_names = ['barry', 'gregory.p.smith', 'pitrou', 'scoder']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue47153'
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

Start with the linked BPO issue 47153 and its interpreter-core context. The issue names no files, tests, or concrete acceptance criteria, so first determine which doc cases should be writable and where they are implemented. Done should include agreed behavior and corresponding test coverage.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
compilers
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.