econchick / econchick/interrogate

Quality of docstr

Open
#156 4 comments 1 reaction 1 assignee Claimed by @econchick View on GitHub
enhancement help wanted
Dominant language
Python
Stars
676
Forks
55
PR merge metrics
No merged PRs in 30d

Description

### Describe the feature you'd like

Currently interrogate only checks if docstrings are present without putting any value on the quality, e.g.

* Minimum summary length
* Parameters/Args are documented
* Return is documented
* Raised exceptions are documented

I understand this would be a larger piece of work due to the different docstring styles that require parsing.

### Is your feature request related to a problem?

Increase the quality of docstrings.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.