Hacker Newsnew | past | comments | ask | show | jobs | submit | constant_flux's commentslogin

I agree. I don't understand some of the black and white thinking in the comments.


Did you stop to consider that perhaps other people learn differently than you, and find examples as a way to soften the friction that context switching causes in a job?

I don't understand the resistance to examples being a part of documentation (and not a bonus).


I think you're being unfair. The blog post claimed "Examples are the best documentation". If I use your own logic, shouldn't I say to the blog writer "Haven't you ever thought people learn differently from you?".

I think harimau777 was just expressing his opinion, like the blog owner.


It shouldn't be an either/or situation. Good documentation should include both the API spec _and_ examples. I believe the person you're replying to was complaining about documentation that's _only_ examples since it seems like that's what TFA was advocating for.


sometimes professionals need to fix shit and need exacting clarity



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

Search: