search

codetriage / docs_doctor

http://docsdoctor.org
27 stars 21 forks source link

Use Ruby `.document` convention #1

Closed zzak closed 10 years ago

zzak commented 10 years ago

Today I received a notification about a method that comes from Ruby's ./sample directory.

AFAIK this directory is purposefully left out of .document, so it's not included in the documentation of Ruby; and as such should not be included in docs_doctor.

zzak commented 10 years ago

@schneems ping

schneems commented 10 years ago

Sorry about the delay. Github does not auto "watch" repos for me. We are excluding test and spec directories https://github.com/schneems/docs_doctor/blob/master/lib/docs_doctor/parsers/ruby/yard.rb#L7

Either we can use this regex or have a per repo regex and pull that data in when we parse the docs

schneems commented 10 years ago

It seems reasonable to exclude hidden directories by default