curses: initscr(), newterm(), start_color() and the screen type have no docstrings
还没有人认领这个 Issue。
- 主要语言
- Python
- 星标
- 77.2k
- 派生
- 35.9k
- 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