3 ms·
This. Documentation should answer WHYs not HOWs.* * = Unless the how is a complex, opaque, or obscure algorithm. Then sometimes a written explanation can help
by Xss3 1y ago
This.
Documentation should answer WHYs not HOWs.*
* = Unless the how is a complex, opaque, or obscure algorithm. Then sometimes a written explanation can help. Sometimes that can be as simple as the name and variant, e.g. Dijkstra with k shortest path routing.