search

lsegal / yard

YARD is a Ruby Documentation tool. The Y stands for "Yay!"
http://yardoc.org
MIT License
1.92k stars 396 forks source link

"Yardoc file" is in fact a directory #268

Closed gioele closed 13 years ago

gioele commented 13 years ago

The Yard documentation and command line help refers to a supposed "yardoc file". Actually, Yard looks for a directory, not a simple file.

lsegal commented 13 years ago

Yes-- we call it a yardoc file for simplicity (and partially historical reasons). The original design used a file, but it was later expanded to a directory-- YARD still supports these legacy "files". The implementation details of the node itself are not important, so calling it a "file" is the best distinction.