New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE] Compodoc to measure documentation coverage #67

Closed
RomanKisilenko opened this Issue Jan 13, 2017 · 1 comment

Comments

Projects
None yet
2 participants
@RomanKisilenko

RomanKisilenko commented Jan 13, 2017

Motivation for or Use Case

It is very useful to know if the team documents the code as it is specified in project standards. For this, measuring the documentation coverage (i.e. number of items documented versus total number of items which can be reasonably documented) is a valuable tool.

For instance, esdoc generates the coverage report for ES6 code and we find it very useful to process results automatically in a CI.

@vogloblinsky

This comment has been minimized.

Show comment
Hide comment
@vogloblinsky

vogloblinsky Jan 14, 2017

Contributor

Hi,
Yes, it could be a nice feature. I keep this idea for next major release.
R.

Contributor

vogloblinsky commented Jan 14, 2017

Hi,
Yes, it could be a nice feature. I keep this idea for next major release.
R.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment