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