Skip to content
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

build: add documentation coverage checks #424

Closed
dsebastien opened this issue Jun 8, 2018 · 1 comment
Closed

build: add documentation coverage checks #424

dsebastien opened this issue Jun 8, 2018 · 1 comment

Comments

@dsebastien
Copy link
Contributor

dsebastien commented Jun 8, 2018

I'm submitting a...


[ ] Regression (a behavior that used to work and stopped working in a new release)
[ ] Bug report  
[x] Feature request
[ ] Documentation issue or request
[ ] Support request => Please do not submit support request here, instead see https://github.com/NationalBankBelgium/stark/blob/master/CONTRIBUTING.md#got-a-question-or-problem

Current behavior

We don't check for code documentation coverage.

Expected behavior

We should check for documentation coverage at two levels:

  • pre-commit (hook)
  • Travis CI

We should at least always have >=85% documentation coverage. If we can go higher, all the better indeed ;-)

What is the motivation / use case for changing the behavior?

In order to maintain the quality of the API docs, we need to at least check for completion %.

@Mallikki
Copy link
Contributor

Mallikki commented Jun 11, 2018

I've done the pre-commit part so far. (#429)

Still need to work on the Travis CI with @christophercr as discussed.

Edit: added! We still need to discuss if the coverage check in .travis.yml is sufficient enough.

Also, the coverage value is now at 85% (was previously set at 70%, the default value)

Mallikki added a commit that referenced this issue Jun 12, 2018
@Mallikki Mallikki reopened this Jun 19, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants