rapidsai/cudf

Enable numpydoc validation

開放

#11,253 建立於 2022年7月12日

在 GitHub 查看貢獻者指南
 (27 則留言) (0 個反應) (0 位負責人)C++ (735 個分叉)batch import
0 - BacklogPythondocgood first issue

倉庫指標

星標
 (6,000 顆星)
PR 合併指標
 (平均合併 17天 21小時) (30 天內合併 230 個 PR)

描述

numpydoc supports docstring validation that we should enable to supplement things like pydocstyle checks. The numpydoc validation will help us with more semantic checking, such as ensuring that docstrings actually align with the function signatures that they are attached to.

貢獻者指南

研究方向
查看議題評論中關於實作細節和潛在問題的先前討論。檢查專案現有的文件驗證設定在CI配置檔案（例如.github/workflows、setup.cfg）中，以了解如何整合numpydoc驗證。numpydoc文件提供了啟用驗證的指引。需要驗證的具體函式是cuDF中的Python函式。
技術棧
python
領域
documentationdeveloper experience
議題類型
維護
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
GitPython
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
75