rapidsai/cudf

Enable numpydoc validation

Open

#11,253 opened on Jul 12, 2022

View on GitHub
 (24 comments) (0 reactions) (0 assignees)C++ (6,000 stars) (735 forks)batch import
0 - BacklogPythondocgood first issue

Description

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.

Contributor guide

Tech stack
python
Domain
documentationtesting
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic knowledge of Python docstringsFamiliarity with numpydocUnderstanding of CI workflows
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Review the issue comments for any previous discussion on implementation details and potential pitfalls. Examine the project's existing documentation validation setup in CI configuration files (e.g., .github/workflows, setup.cfg) to understand how to integrate numpydoc validation. The numpydoc documentation provides guidance on enabling validation. The specific functions to validate are Python functions in cuDF.