Docu: missing return values for Checker.check_all()
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 42/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- python
调研方向
首先，在 repository 唯一的 Python 源文件中定位 Checker.check_all()，并将其行为与 ReadTheDocs 文档进行比较。记录该方法的参数、返回值和引发的异常，然后检查对应的源代码与 ReadTheDocs 条目是否一致。当返回行为对用户来说清晰明确且相关文档完整时，即视为完成。
由索引模型根据 Issue 内容生成。
描述
The docu on source and on readthedocs is unclear about if and what Checker.check_all() returns.
Of course I can read the source and find the answer. But it would easier for all users if all classes and methods would provide a full documentation in the docstring on all arguments, return values and raised exceptions.
- 主要语言
- Python
- 星标
- 5.2k
- 派生
- 756
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
PyCQA/pycodestyle 的其他 Issue
-
难度 1/5 1 小时以内 新手友好度 82/100
PyCQA/pycodestyle#1294 · 1 条评论 ·
-
难度 5/5 一周以上 新手友好度 25/100
PyCQA/pycodestyle#1302 · 3 条评论 ·
-
难度 3/5 1-2 天 新手友好度 42/100
PyCQA/pycodestyle#1242 · 2 条评论 ·
-
难度 3/5 1-2 天 新手友好度 68/100
PyCQA/pycodestyle#1241 · 2 条评论 · 4 个 reaction ·
-
难度 3/5 1-2 天 新手友好度 45/100
PyCQA/pycodestyle#1217 ·
查看 PyCQA/pycodestyle 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 85/100
维护者通常 1 天内回复
-
approved correction metadata
难度 1/5 1 小时以内 新手友好度 88/100
acl-org/acl-anthology#10133 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
BasedHardware/omi#20084 ·
维护者通常 1 天内回复
-
bug needs-acceptance wg/evaluation-quality
难度 2/5 1-3 小时 新手友好度 76/100
vllm-project/semantic-router#4424 ·
维护者通常 1 天内回复