Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Let YARD document the railties gem

  • Loading branch information...
commit 5949e705f496c78fa125610d581a9339fa63da94 1 parent 74b49e8
@bcardarella bcardarella authored wycats committed
Showing with 1 addition and 0 deletions.
  1. +1 −0  .yardopts
View
1  .yardopts
@@ -1,3 +1,4 @@
--exclude /templates/
--quiet
act*/lib/**/*.rb
+railties/lib/**/*.rb

5 comments on commit 5949e70

@rails3book

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

@fxn
Owner

Nope.

@luckydev

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 ?

@bcardarella

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

@fxn
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.