18 ms·
When you're reading the documentation for a software library, do you prefer if it includes examples for common usage or do you prefer a long list of API methods
by jannes 7y ago
When you're reading the documentation for a software library, do you prefer if it includes examples for common usage or do you prefer a long list of API methods?
Have you ever used the "examples" section of a man page or do you prefer to scroll through the (sometimes long) list of parameters?
In my opinion, code examples are an important tool for teaching real-life usage patterns.