Comment

Comment by throw10920

I'm guilty of this too! Change begins with one's self, they say, heh. (I should learn to write good docs before castigating the community)

And you're right - trivial docstrings for all the functions isn't documentation at all. Real documentation is the four-part system[1] of tutorials, howtos, examples, and reference material - I've found this mental framework to be enormously helpful for both (a) identifying when some other documentation is inadequate and (b) improving my own.

[1] https://documentation.divio.com/

parent throw10920 5 years ago

Discussion

Live from the official Hacker News API

A modern reader for Hacker News · SvelteKit + Skeleton