Type signature of @property not shown in help()

説明

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']

はじめの一歩

issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。

着手することを issue にコメントします — 二人が同じ作業をするのを防げます。

リポジトリをフォークし、ブランチを切って変更します。

issue 番号を参照したプルリクエストを送ります。

調査の方向性

この issue では Python の help() の出力と @property の型シグネチャに言及していますが、ファイル、テスト、実装のエントリーポイントについては触れていません。まず help() の処理と、プロパティのドキュメントに関する既存のテストを見つけます。help() が、他のドキュメント化されたシグネチャと一貫した形でプロパティの型シグネチャを表示すれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック

python

領域

documentation

issue の種類

機能追加

難易度

4/5

見積もり時間

3〜5日

活発さ

停滞

明瞭さ

説明が足りない

初心者へのやさしさ

35/100

説明

コントリビューションガイド

はじめの一歩

調査の方向性

評価

新しい issue をメールで受け取る