econchick / econchick/interrogate

[Feature Request] add parameters and return object coverage

Open
#53 2 comments 0 reactions 1 assignee Claimed by @econchick View on GitHub
enhancement needs triage
Dominant language
Python
Stars
676
Forks
55
PR merge metrics
No merged PRs in 30d

Description

One thing I think is absent from this tool, as well as from [pydocstyle](https://github.com/PyCQA/pydocstyle) and other documentation validation tools, is the ability to check that all **parameters** are documented, not just the **methods**. If this tool would have this ability, I would really like to use it.

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.