search

Thomas-Oz-Dunn / donnager

Tools for modelling space exploration
https://crates.io/crates/donnager
MIT License
0 stars 0 forks source link

Automate Module Docstring and Test Tracking #39

Open Thomas-Oz-Dunn opened 1 year ago

Thomas-Oz-Dunn commented 1 year ago

Background

A subset of functions and classes are documented, another subset have unit tests, another subset have integration tests. It will soon become impossible to manually keep track of what remains to be updated.

Procedure

  1. Create or find a regex-based Docstring detector, lint the format as well
  2. Curate a list of all modules, and all modules run during unit tests
  3. Integrate into CI pipeline with badge generation

Acceptance Criteria

Information on module documentation and testing can be automatically generated from a cli command.

Thomas-Oz-Dunn commented 1 year ago

Consider: https://github.com/xd009642/tarpaulin