Explain threshold in README

dkubb / yardstick

A tool for verifying YARD documentation coverage

http://wiki.github.com/dkubb/yardstick

MIT License

172 stars 22 forks source link

Closed trans closed 10 years ago

trans commented 10 years ago

What exactly is threshold? I see no explanation for it in the README.

mbj commented 10 years ago

If your documentation coverage is below or above threshold the yardstick executable exits nonzero and prints that fact. Same for the rake task.

The idea is your action should not affect the coverage score without your knowlege and adjustment.

I'd love to see a PR explaining it correctly.

I'm closing the issue now. Feel free to discuss along.

mbj commented 10 years ago

Reopening because I think its an issue that should be closed from a README change.

mbj commented 10 years ago

Was fixed with #20.