Misleading documentation for NotImplemented

説明

BPO	39111
Nosy	@stevendaprano, @Murali

^{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-20.16:42:56.150>
labels = ['3.8', 'type-feature', '3.7', '3.9', 'docs']
title = 'Misleading documentation for NotImplemented'
updated_at = <Date 2019-12-28.07:11:38.640>
user = 'https://github.com/Murali'

bugs.python.org fields:

activity = <Date 2019-12-28.07:11:38.640>
actor = 'terry.reedy'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2019-12-20.16:42:56.150>
creator = 'murali'
dependencies = []
files = []
hgrepos = []
issue_num = 39111
keywords = []
message_count = 5.0
messages = ['358719', '358722', '358723', '358726', '358752']
nosy_count = 3.0
nosy_names = ['steven.daprano', 'docs@python', 'murali']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue39111'
versions = ['Python 3.7', 'Python 3.8', 'Python 3.9']

はじめの一歩

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

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

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

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

調査の方向性

まず、NotImplemented のドキュメントとリンク先の BPO issue 39111 を確認し、どの表現が誤解を招くのかを特定します。issue の payload にはファイル、テスト、具体的な修正のいずれも記載されていないため、編集する前に意図されたドキュメントの変更内容を確認し、改訂後のテキストが NotImplemented を正確に説明していることを検証してください。

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

評価

技術スタック

python

領域

documentation

issue の種類

ドキュメント

難易度

2/5

見積もり時間

1〜3時間

活発さ

停滞

明瞭さ

説明が足りない

初心者へのやさしさ

35/100

説明

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

はじめの一歩

調査の方向性

評価

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