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