←back to thread

Examples are the best documentation

(rakhim.exotext.com)
401 points Bogdanp | 1 comments | 09 Oct 25 19:34 UTC | HN request time: 0.276s | source
Show context
gbalduzzi ◴[10 Oct 25 05:51 UTC] No.45535697[source]▶
You need both and there are no ways around that.

Examples let you grasp immediately how to use the library and provide you good starting point for your integration.

Detailed explanation of all params and configurations allows you to solve more complex problems and understand the full capabilities of the tool.

I am miserable when any of the two kind of documentation is missing.

The only exceptions are very simple libraries, where the example tells you already everything there is to know.

replies(2): >>45536399 #>>45544325 #
1. jopsen ◴[10 Oct 25 08:04 UTC] No.45536399[source]▶
Agreed, examples and reference docs.

When feasible, I'd add repl environments. The ability to quickly modify and test the example can make up for a lot of the shortcomings documentation might have.