add docstr-coverage workflow

[epassaro]

Description

I used the docstr-coverage package to check the docstring coverage of TARDIS. This package is well maintained and offers an interesting number of options that can be declared on the .docstr.yaml file.

To try these changes locally, first install docstr-coverage latest commit:

pip install docstr-coverage

and then run docstr-coverage on tardis repository folder.

---

To integrate this package with our continuous integration cycle, I wrote a simple GitHub workflow which runs docstr-coverage twice:

• First, on the base of the pull_request and set the coverage as future THRESHOLD value.
• Then, on the HEAD of the pull_request, failing if coverage is lower than THRESHOLD (for example, after writing a new function, class or method without any docstring).

---

BEFORE MERGE:

• Discuss the final options to be used in .docstring.yaml.
• Remove the git checkout ${{ github.event.pull_request.head.sha }} -- .docstr.yaml line. The workflow will fail after doing this because currently .docstr.yaml does not exist on master, but this is fine.

Motivation and Context

We want to get some information about the status of TARDIS documentation coverage and integrate that on our CI cycle.

How Has This Been Tested?

• Testing pipeline
• Other (please describe)

New GitHub Action.

Screenshots (if appropriate):

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• None of the above (please describe)

Checklist:

• My code follows the code style of this project
• My change requires a change to the documentation
• I have updated the documentation accordingly
• I have built the documentation on my fork following these instructions
• I have assigned and requested two reviewers for this pull request

[codecov]

Codecov Report

Merging #1409 (1650c06) into master (4a6a8a6) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #1409   +/-   ##
=======================================
  Coverage   71.16%   71.16%           
=======================================
  Files          67       67           
  Lines        5521     5521           
=======================================
  Hits         3929     3929           
  Misses       1592     1592           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4a6a8a6...1650c06. Read the comment docs.