Permalink
Browse files

Let YARD document the railties gem

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

5 comments on commit 5949e70

@rails3book

This comment has been minimized.

Show comment
Hide comment
@rails3book

rails3book Nov 9, 2010

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

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

@fxn

This comment has been minimized.

Show comment
Hide comment
@fxn

fxn Nov 9, 2010

Member

Nope.

Member

fxn replied Nov 9, 2010

Nope.

@luckydev

This comment has been minimized.

Show comment
Hide comment
@luckydev

luckydev Nov 9, 2010

Contributor

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 ?

Contributor

luckydev replied Nov 9, 2010

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

This comment has been minimized.

Show comment
Hide comment
@bcardarella

bcardarella Nov 9, 2010

Contributor

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

Contributor

bcardarella replied Nov 9, 2010

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

@fxn

This comment has been minimized.

Show comment
Hide comment
@fxn

fxn Nov 9, 2010

Member

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.

Member

fxn replied Nov 9, 2010

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.