eclecticiq / OpenTAXII

TAXII server implementation in Python from EclecticIQ
BSD 3-Clause "New" or "Revised" License
189 stars 89 forks source link

Get visibility into docstring coverage #211

Closed erwin-eiq closed 2 years ago

erwin-eiq commented 2 years ago

Short description

Get additional visiblity into status of docs

Motivation

Docstrings are good for developers. We could use significantly more (and better, but that's hard to measure). This MR is a small attempt at introducing some visibility into the status of docstrings.

Implementation

Uses interrogate in a job coverage doesn't drop below the current value. Current coverage is 32.7%, with a setting that ignores coverage for a bunch of things. As time passes and docs improve, we might tighten the settings or increase the goal.