Undocumented Cmd method print_topics
还没有人认领这个 Issue。
- 主要语言
- Python
- 星标
- 77.2k
- 派生
- 36k
- PR 合并指标
- PR 指标待抓取
描述
Documentation
When exploring the Cmd Python library, I realized that there is no documentation for print_topics method.
I only realized the missing documentation because I noticed that print_topics method has an unused parameter called cmdlen, and I couldn't figure out if it is actually useful for something.
I could also notice that on typeshed it is typed as Any, even though it seems to be only used as an int.
Extra doubts:
Maybe print_topics should be renamed to _print_topics or we should document how to use it properly?
Also, is that cmdlen parameter really needed?
I am willing to contribute with that, but I don't know which type of issue I should open to report an unused param.
Links:
- Cmd documentation: https://docs.python.org/3.13/library/cmd.html
- Cdm.print_topics definition: https://github.com/python/cpython/blob/main/Lib/cmd.py#L346
- typeshed: https://github.com/python/typeshed/blob/main/stdlib/cmd.pyi#L45
Linked PRs
- gh-134539
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
从 Lib/cmd.py#L346 中的 print_topics 定义、Cmd 文档及其 typeshed 声明开始。在决定预期的公共行为之前,审阅链接的 PR gh-134539 以及关于 cmdlen、命名和类型标注的未解决问题。完成意味着已记录约定的行为和参数用法,并在需要时处理 typeshed 注解。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- python
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 活跃度
- 停滞
- 描述清晰度
- 需要澄清
- 新手友好度
- 35/100