python / python/cpython

Add a tutorial for cmd.Cmd for `emptyline()` and `do_EOF`

未關閉
#144,338 9 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

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

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

研究方向

先閱讀 cmd.Cmd 文件和 issue #143804,以了解現有的方法級說明以及回報的困惑。新增一個使用層級的教學,介紹 emptyline() 和 do_EOF,包括預期行為和乾淨退出,然後確認文件是否清楚地說明這兩個覆寫方法。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
python
領域
documentation
Issue 類型
文件
難度
2/5
預估耗時
1-3 小時
活躍度
停滯
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。