return value of builtins is not clearly indicated

説明

BPO	46282
Nosy	@warsaw, @terryjreedy, @nedbat, @merwok, @stevendaprano, @iritkatriel, @snoopjedi
PRs	python/cpython#30435

^{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 2022-01-06.14:52:27.230>
labels = ['3.11', 'docs']
title = 'return value of builtins is not clearly indicated'
updated_at = <Date 2022-02-12.01:20:07.186>
user = 'https://github.com/SnoopJeDi'

bugs.python.org fields:

activity = <Date 2022-02-12.01:20:07.186>
actor = 'rhettinger'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2022-01-06.14:52:27.230>
creator = 'SnoopJeDi'
dependencies = []
files = []
hgrepos = []
issue_num = 46282
keywords = ['patch']
message_count = 17.0
messages = ['409857', '409870', '409874', '409883', '409886', '410038', '410046', '411632', '411653', '411664', '411668', '411809', '411835', '412797', '412811', '412836', '412838']
nosy_count = 8.0
nosy_names = ['barry', 'terry.reedy', 'nedbat', 'eric.araujo', 'steven.daprano', 'docs@python', 'iritkatriel', 'SnoopJeDi']
pr_nums = ['30435']
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue46282'
versions = ['Python 3.11']

はじめの一歩

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

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

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

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

調査の方向性

まず BPO issue 46282 と PR #30435 に関連する議論を確認してください。この issue にはすでに patch review のマークが付いています。この作業の対象となる builtin のドキュメントの記述を特定し、ドキュメントの変更が完了した時点で、それらの戻り値が明確に示されていることを確認してください。

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

評価

技術スタック

python

領域

documentation

issue の種類

ドキュメント

難易度

3/5

見積もり時間

1〜2日

活発さ

停滞

明瞭さ

説明が足りない

初心者へのやさしさ

15/100

説明

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

はじめの一歩

調査の方向性

評価

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