python / python/cpython

Cmd.onecmd documentation is misleading

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

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

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

説明

BPO 32283

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 2017-12-12.00:20:54.862>
labels = ['3.7', 'library']
title = 'Cmd.onecmd documentation is misleading'
updated_at = <Date 2017-12-12.00:20:54.862>
user = 'https://bugs.python.org/lyda'

bugs.python.org fields:

activity = <Date 2017-12-12.00:20:54.862>
actor = 'lyda'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = ['Library (Lib)']
creation = <Date 2017-12-12.00:20:54.862>
creator = 'lyda'
dependencies = []
files = []
hgrepos = []
issue_num = 32283
keywords = []
message_count = 1.0
messages = ['308082']
nosy_count = 1.0
nosy_names = ['lyda']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue32283'
versions = ['Python 3.6', 'Python 3.7']

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

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

はじめの一歩

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

調査の方向性

まず Cmd.onecmd のライブラリドキュメントを見つけ、その記述をドキュメント化されている動作と比較します。この issue ではファイルが特定されておらず、どの文言が誤解を招くのかも説明されていないため、編集する前に必要な明確化を判断してください。完了とは、ドキュメントが Cmd.onecmd を正確に説明し、ドキュメントのチェックが通ることを意味します。

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

評価

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

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

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