Skip to content

Quality of docstr #156

@estahn

Description

@estahn

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.

Metadata

Metadata

Assignees

Labels

enhancementNew feature or requesthelp wantedHelp! I have a full time job and would love contributions!

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions