Add "raises <exception type>" to docstrings

仓库指标

星标

1,296 个星标 (1,296 个星标)

PR 合并指标

平均合并 19天 5小时 (平均合并 19天 5小时)30 天内合并 6 个 PR (30 天内合并 6 个 PR)

描述

贡献者指南

研究方向

检查Python客户端代码库中的文档字符串，特别是可能引发异常的方法。按照现有的文档字符串风格添加`:raises ExceptionType:`描述。

技术栈

python

领域

documentation

议题类型

文档

难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。

2

预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。

1-3 小时

活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。

活跃

清晰度议题是否清楚说明期望改动、验收标准和下一步。

清晰

前置要求

GitPython

新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。

75