search

inch-ci / inch_ci-web

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

Inch wants me to document a private method #51

Open ghost opened 9 years ago

ghost commented 9 years ago

When I run inch locally, I don't get told to document a method that is private, however on the CI I am. Why is that? There's another private method in the same place but it doesn't get mentioned by Inch.

CI

Local

Re: [U] Crib::Request#request in rafalchmiel/crib

rrrene commented 9 years ago

A private method is considered low-priority in Inch, which means they are not excluded from suggestions per se, but are considered unimportant in terms of documentation needs. However, Inch has another rule that says "methods with many parameters should be documented" and these methods get assigned a higher priority. This is why the method could be documented albeit being a private one.

As to why the CLI does not show it - this is an inconsistency, which is due to an old compaitibility with YARD's command line arguments (private methods are hidden by default, regardless of their priority). Maybe I should change that for v1.0.0 or at least make it more transparent.