curses: initscr(), newterm(), start_color() and the screen type have no docstrings
還沒有人認領這個 Issue。
- 主要語言
- Python
- 星號
- 77.2k
- 分支
- 36k
- PR 合併指標
- PR 指標待擷取
描述
Bug report
curses.initscr(), curses.newterm() and curses.start_color() are Python wrappers of the C functions (they copy the ACS_*, LINES/COLS and COLORS/COLOR_PAIRS constants into the package), and the wrappers have no docstring, so help(curses.initscr) shows nothing although _curses.initscr is documented. The curses.screen type has no docstring either, unlike window, complexchar and complexstr.
Also, the docstring of _curses.initscr() says "Return a WindowObject", the name of the C struct rather than the Python type.
Linked PRs
- gh-157547
貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
研究方向
從 curses.initscr()、curses.newterm()、curses.start_color() 和 curses.screen 這些進入點開始，將它們的說明輸出與文件中記載的 _curses.initscr()、window、complexchar 和 complexstr 型別進行比較。完成的標準是 wrapper 和 screen 型別具有實用的 docstring，且 _curses.initscr() 正確命名 Python 型別；開始前請檢查連結的 gh-157547 工作。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- python
- 領域
- documentation
- Issue 類型
- 文件
- 難度
- 3/5
- 預估耗時
- 1-2 天
- 活躍度
- 停滯
- 描述清晰度
- 描述清楚
- 新手友好度
- 25/100