python / python/cpython

Type signature of @property not shown in help()

Open
#83,306 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

BPO 39125
Nosy @rhettinger, @McSinyx, @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 2019-12-23.15:40:00.651>
labels = ['type-feature', '3.9', 'docs']
title = 'Type signature of @property not shown in help()'
updated_at = <Date 2021-04-11.00:19:47.157>
user = 'https://github.com/McSinyx'

bugs.python.org fields:

activity = <Date 2021-04-11.00:19:47.157>
actor = 'rhettinger'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2019-12-23.15:40:00.651>
creator = 'McSinyx'
dependencies = []
files = []
hgrepos = []
issue_num = 39125
keywords = []
message_count = 5.0
messages = ['358823', '358825', '359041', '390625', '390754']
nosy_count = 5.0
nosy_names = ['rhettinger', 'docs@python', 'McSinyx', 'xtreak', 'brenthuisman']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue39125'
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

The issue names Python's help() output and @property type signatures but mentions no files, tests, or implementation entry points. Start by locating the help() handling and existing tests for property documentation; done means help() displays the property's type signature consistently with other documented signatures.

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
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.