Yes, I mean documentation in general. It's fine to just show a long list of meth... | Hacker News

Hacker Newsnew | past | comments | ask | show | jobs | submit

whatnotests on March 12, 2016 | parent | context | favorite | on: The Open API Initiative

Yes, I mean documentation in general.

It's fine to just show a long list of method signatures and class hierarchies, but a working code sample is the picture that's worth a thousand words.

progx on March 12, 2016 [–]

You mean something like this:

http://apidocjs.com/example/

generated from this

https://github.com/apidoc/apidocjs.com/tree/gh-pages/source/...

whatnotests on March 12, 2016 | [–]

Very nice! I particularly like the ability to compare two different versions visually.

Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact