Re:Examples Are the Best Documentation
by sfn42 on Friday October 10, 2025 @01:39PM
(#45541626)
Nobody said don't add examples. Just don't do it before creating proper API docs.
[ Parent
| on HN ]
That's on me - I over-focused on the leading sentences/paragraphs of the replies ("Please don't follow this advice [that examples are the best documentation]"), and missed that the first comment had "Also having examples is fine, but they should be considered a bonus" in the last paragraph. You're right!