Intra-package References Documentation Incomplete

説明

BPO	35927
Nosy	@brettcannon, @terryjreedy, @ncoghlan, @ericsnowcurrently
Files	sound.zip: zip of code sample copied from documentation

^{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-02-07.04:38:30.393>
labels = ['3.8', 'type-bug', '3.7', 'docs']
title = 'Intra-package References Documentation Incomplete'
updated_at = <Date 2019-02-14.00:38:19.737>
user = 'https://bugs.python.org/ADataGman'

bugs.python.org fields:

activity = <Date 2019-02-14.00:38:19.737>
actor = 'ADataGman'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2019-02-07.04:38:30.393>
creator = 'ADataGman'
dependencies = []
files = ['48109']
hgrepos = []
issue_num = 35927
keywords = []
message_count = 7.0
messages = ['335002', '335104', '335105', '335126', '335303', '335385', '335486']
nosy_count = 6.0
nosy_names = ['brett.cannon', 'terry.reedy', 'ncoghlan', 'docs@python', 'eric.snow', 'ADataGman']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue35927'
versions = ['Python 3.7', 'Python 3.8']

はじめの一歩

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

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

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

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

調査の方向性

リンクされたBPO issue 35927を読み、ドキュメントからコピーされたコード例であるsound.zipを調べることから始めます。関連するPythonドキュメントで、不足している、または不完全なパッケージ内参照を特定します。コード例で示されている参照をドキュメントが完全にカバーし、適切なドキュメントチェックが通れば完了です。

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

評価

技術スタック

python

領域

documentation

issue の種類

ドキュメント

難易度

3/5

見積もり時間

1〜2日

活発さ

停滞

明瞭さ

説明が足りない

初心者へのやさしさ

35/100

説明

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

はじめの一歩

調査の方向性

評価

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