python / python/cpython

Misleading membersip expression documentation

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

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

3.10 docs type-bug
主要言語
Python
スター
77.2k
フォーク
36k
PR マージ指標
PR 指標を取得中

説明

BPO 45832
Nosy @rhettinger, @ericvsmith, @ezio-melotti, @merwok, @serhiy-storchaka, @willingc, @JulienPalard, @harahu

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 2021-11-17.19:00:34.359>
labels = ['type-bug', '3.10', 'docs']
title = 'Misleading membersip expression documentation'
updated_at = <Date 2021-11-20.12:41:47.585>
user = 'https://github.com/harahu'

bugs.python.org fields:

activity = <Date 2021-11-20.12:41:47.585>
actor = 'harahu'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2021-11-17.19:00:34.359>
creator = 'harahu'
dependencies = []
files = []
hgrepos = []
issue_num = 45832
keywords = []
message_count = 7.0
messages = ['406485', '406490', '406497', '406502', '406526', '406649', '406651']
nosy_count = 9.0
nosy_names = ['rhettinger', 'eric.smith', 'ezio.melotti', 'eric.araujo', 'docs@python', 'serhiy.storchaka', 'willingc', 'mdk', 'harahu']
pr_nums = []
priority = 'normal'
resolution = 'third party'
stage = None
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue45832'
versions = ['Python 3.10']

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

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

はじめの一歩

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

調査の方向性

まず BPO issue 45832 を読み、membership expression に関する Python ドキュメントのセクションを特定します。payload にはファイルもセクションも記載されていません。意図された文言を明確にし、ドキュメントを更新して、改訂後のテキストが誤解を招くものではなくなっていることを確認します。

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

評価

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

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

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