search

inch-ci / inch_ci-web

Web frontend for Inch CI
http://inch-ci.org/
MIT License
139 stars 20 forks source link

Inch claims no docs, not actually the case #149

Open grempe opened 8 years ago

grempe commented 8 years ago

I'm trying to understand why several methods are found to have no docs by Inch CI, when actually every one of them has docs.

https://inch-ci.org/github/grempe/tss-rb

Is there something wrong with the docs that is causing them to be ignored? Or a parsing issue?

Re: [U] TSS::Util.calc_combinations in grempe/tss-rb

rrrene commented 8 years ago

We are leveraging YARD's parsing engine for the docs and my best guess is that the default parsing does not know how to deal with the Contract calls. All objects identified as undocumented have those calls residing between the doc string and the method definition.

Unfortunately that would mean that we can not do much about it, unless you have any ideas ...

grempe commented 8 years ago

Well actually, almost every function in this lib has a contract (except for a few exceptions that are called millions of times and are performance sensitive).

I wonder, do you use the .yardopts file present in a project when parsing docs? This contains hints on how to generate docs when including Contracts.

https://github.com/grempe/tss-rb/blob/master/.yardopts