python / python/cpython

Profile 'builtins' parameter documentation missing

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

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

3.7 (EOL) 3.8 (EOL) 3.9 (EOL) docs stdlib
主要言語
Python
スター
77.2k
フォーク
36k
PR マージ指標
PR 指標を取得中

説明

BPO 40205
Nosy @terryjreedy, @bharel

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-04-06.14:43:33.212>
labels = ['3.8', '3.7', 'library', '3.9', 'docs']
title = "Profile 'builtins' parameter documentation missing"
updated_at = <Date 2020-04-11.01:16:06.060>
user = 'https://github.com/bharel'

bugs.python.org fields:

activity = <Date 2020-04-11.01:16:06.060>
actor = 'terry.reedy'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation', 'Library (Lib)']
creation = <Date 2020-04-06.14:43:33.212>
creator = 'bar.harel'
dependencies = []
files = []
hgrepos = []
issue_num = 40205
keywords = []
message_count = 2.0
messages = ['365859', '366173']
nosy_count = 3.0
nosy_names = ['terry.reedy', 'docs@python', 'bar.harel']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue40205'
versions = ['Python 3.7', 'Python 3.8', 'Python 3.9']

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

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

はじめの一歩

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

調査の方向性

ペイロードではドキュメントファイルもテストも指定されていません。profile 関数の builtins パラメーターに関するドキュメント項目を特定し、不足している説明を追加して、結果のリファレンスドキュメントでそれが明確に説明されていることを確認してください。

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

評価

技術スタック
python
領域
documentation
issue の種類
ドキュメント
難易度
2/5
見積もり時間
1〜3時間
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
35/100

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

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