search

christabor / random-ideas

Random project ideas that have not been implemented, for the world to see (and perhaps do, if interested!)
MIT License
2 stars 0 forks source link

Docstring linter for pytest et al #10

Open christabor opened 6 years ago

christabor commented 6 years ago

This is NOT for checking things like pydocstyle - those already exist.

A docstring linter that does the following for all files in a folder and subfolders (e.g. package):

  1. Determine the number of functions/classes and determine % of each that have docstrings
  2. Determine the type signature and which docstrings actually are in line (measuring docstring "regression")