New answers tagged

0

Answering my own question to address a few points since no one else has addressed them fully. Yes, the API documentation should have these details. These details are absolutely critical in many scenarios including the survival of the language sometimes. Also, there are some downsides to them as well. Why it should be there Easier learning curve While it ...


5

I definitely agree that documentation should contain the extra information that you suggest, but at the same time that is hard to get right, boring to do and takes effort. John Resig (creator of jQuery), in an interview about Building jQuery at 4:19 into the interview, talks about how his documentation with examples of jQuery was one of the best early ...


5

Yes, having all of this information directly in the documentation is quite useful. Good documentation gives you all of the information you need to understand the API, interface, or other tool--and this is something which goes beyond a simple technical description of how it works. There are examples of documentation that does this. One that I am familiar ...


1

I have used a few APIs and went through the documentation. Developers usually do not refer to the API documentation to make judgement about whether they should use it or not/ where does this API stand with respect to others etc. The API documentation is used only when you know you are going to give it a try. It's treated like a piece of document that's ...



Top 50 recent answers are included