astropy / astropy/pyvo

CI: adding numpydoc linter

Open
#630 0 comments 1 reaction 0 assignees View on GitHub
infrastructure
Dominant language
Python
Stars
88
Forks
64
Avg merge
38m
Merged PRs (30d)
1

Description

While I'm doing code review I run into a couple of non numpydoc compliant docstrings. Which is not a big deal, but rendering those docstrings won't look good, so we should really fix them up. And to avoid unnecessary nitpicky comments in the review, we may want to do this via CI.

Contributor guide

No contributing guide indexed for this repository

Research direction

The issue does not name any files, tests, or existing CI entry points. Start by locating the repository's CI configuration and the docstrings that fail numpydoc compliance; done means the identified docstrings render correctly and CI checks for future non-compliance.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
ci-cd
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.