←back to thread

401 points Bogdanp | 3 comments | | HN request time: 0.21s | source
1. gbalduzzi ◴[] 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 #
2. jopsen ◴[] 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.

3. joemi ◴[] No.45544325[source]
I'm honestly surprised there are people who think that only examples are fine. And I'm equally surprised there are people who think only reference docs are fine. It's so infuriating coming across a project that only has one kind and not the other.