Skip to content
This repository
Browse code

Let YARD document the railties gem

  • Loading branch information...
commit 5949e705f496c78fa125610d581a9339fa63da94 1 parent 74b49e8
Brian Cardarella authored September 03, 2010 wycats committed September 09, 2010

Showing 1 changed file with 1 addition and 0 deletions. Show diff stats Hide diff stats

  1. 1  .yardopts
1  .yardopts
... ...
@@ -1,3 +1,4 @@
1 1
 --exclude /templates/
2 2
 --quiet
3 3
 act*/lib/**/*.rb
  4
+railties/lib/**/*.rb

5 notes on commit 5949e70

rails3book

Does this mean that Rails is switching to YARD as its API documentation? [/hopeful]

Xavier Noria
Owner

Nope.

Anand

There are a couple of other options for Rails API. everyone wants good search stuff. Why shouldn't be YARD/other search friendly doc option ?

Brian Cardarella

YARD can parse RDOC so it shouldn't be an issue.

Xavier Noria
Owner

Yeah, it doesn't understand some recent stuff we use but it works.

There's work being done with Hanna, and I believe static parsers are not the way to go for Rails. I prefer effort to be directed towards a new and more dynamic approach. I wrote about it a while back.

Please sign in to comment.
Something went wrong with that request. Please try again.