python / python/cpython

Make documentation of * in function signatures easier to find

オープン
#86,737 コメント 7 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

3.10 3.8 (EOL) 3.9 (EOL) docs type-feature
主要言語
Python
スター
77.2k
フォーク
36k
平均マージ
1日 9時間
マージ済み PR(30日)
558

説明

BPO 42571
Nosy @merwok, @fredg1

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 2020-12-04.21:11:08.529>
labels = ['type-feature', '3.8', '3.9', '3.10', 'docs']
title = 'Make documentation of * in function signatures easier to find'
updated_at = <Date 2020-12-14.14:34:02.476>
user = 'https://github.com/fredg1'

bugs.python.org fields:

activity = <Date 2020-12-14.14:34:02.476>
actor = 'eric.araujo'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2020-12-04.21:11:08.529>
creator = 'fredg1'
dependencies = []
files = []
hgrepos = []
issue_num = 42571
keywords = []
message_count = 5.0
messages = ['382530', '382876', '382965', '382966', '382989']
nosy_count = 3.0
nosy_names = ['eric.araujo', 'docs@python', 'fredg1']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue42571'
versions = ['Python 3.8', 'Python 3.9', 'Python 3.10']

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

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

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

issue ではドキュメントファイルもテストも指定されていません。まず、関数シグネチャに関する CPython のドキュメントと、* の既存の説明を見つけます。読者がシグネチャで * がどのようにドキュメント化されているかを見つけて理解できれば完了です。

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

評価

技術スタック
python
領域
documentation
issue の種類
機能追加
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

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

初心者向けの GitHub issue を短くまとめたダイジェスト。