Add a tutorial for cmd.Cmd for `emptyline()` and `do_EOF`
オープン
まだ誰も着手していません。
docs
triaged
- 主要言語
- Python
- スター
- 77.2k
- フォーク
- 35.9k
- PR マージ指標
- PR 指標を取得中
説明
Documentation
This is w.r.t the issue #143804
It was pointed out it is not a bug (agreed) but we can improve the documentation of this module
since it is now not very clear that
- One has to over-ride "emptyline" so that the last line is not repeated
- One has to over-ride do_EOF to quit cleanly
A tutorial on this in the documentation would be helpful as right now these are at the level of method level documentation and quite unclear at the usage level.
Linked PRs
- gh-145292
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
cmd.Cmd のドキュメントと issue #143804 から始めて、既存のメソッドレベルの説明と報告されている混乱を理解します。emptyline() と do_EOF を扱う使用レベルのチュートリアルを追加し、期待される動作と正常な終了を含めます。その後、ドキュメントで両方のオーバーライドが明確に説明されていることを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100