python / python/cpython

Documentation of attribute reference is unclear

Open
#83,795 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

BPO 39614

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-02-11.23:17:29.166>
labels = ['type-feature', '3.8', 'docs']
title = 'Documentation of attribute reference is unclear'
updated_at = <Date 2020-02-11.23:17:29.166>
user = 'https://bugs.python.org/DirkHerrmann'

bugs.python.org fields:

activity = <Date 2020-02-11.23:17:29.166>
actor = 'Dirk Herrmann'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2020-02-11.23:17:29.166>
creator = 'Dirk Herrmann'
dependencies = []
files = []
hgrepos = []
issue_num = 39614
keywords = []
message_count = 1.0
messages = ['361837']
nosy_count = 2.0
nosy_names = ['docs@python', 'Dirk Herrmann']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue39614'
versions = ['Python 3.8']

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 documentation file, section, entry point, or test is named in the issue. Start with the attribute reference and the linked BPO issue; done means the affected reference has been made clear, though the issue provides no concrete acceptance check.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.