rapidsai/cudf

Enable numpydoc validation

Open

#11,253 opened on Jul 12, 2022

View on GitHub
 (25 comments) (0 reactions) (0 assignees)C++ (735 forks)batch import
0 - BacklogPythondocgood first issue

Repository metrics

Stars
 (6,000 stars)
PR merge metrics
 (Avg merge 17d 21h) (230 merged PRs in 30d)

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

Research direction
Review the numpydoc validation documentation and enable it in the project's configuration files (e.g., setup.cfg, tox.ini, or CI config). Then adjust any existing docstrings that fail the validation.
Tech stack
python
Domain
documentationdeveloper experience
Issue type
Chore
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75