Ruby and Documentation: a rant

Mar 31, 2008 09:58

Why is it that people seem to think that autogenerated "API references" count as documentation?

If I am looking at a new library, I want a tutorial and an overview of the major features. I'm happy to dive into code and API references once I know more or less what I need to look at but please, for the sake of all the little children and their puppies, give me somewhere to bloody start!

Now that I have that out of my system, it's time to dive into this mess and see if I can figure out what I need.

programming, ruby, rant

Previous post Next post
Up