Lightning talk about active doc concept and library

1. ActiveDoc
@iNecas
Brno Ruby Users Group

2. Problem with
documentation
● Out-of-date
● Missing
®
of course we all write crean code :)

3. What would be nice?
● know what kind of value a method
expects
● raise exception as soon possible
● don't put the checking into the
method body

4. Concept
● ActiveDoc
● DSL for ducumenation
● executable
● https://github.com/iNecas/active_doc

5. takes :name, /^[A-Z]/
takes :options, Hash do
takes :lang, [:en, :de, :cs, :sk]
end
def hello_world(name, options = {})
#...
end

6. Describe with
● Type
● DuckType
● Enumerate
● Options Hash
● Regular Expression
● Lambda Expression

7. Conclusion
● Not ready for production yet
● By now only Ruby 1.9
● Ready for hacking
● https://github.com/iNecas/active_doc