←back to thread

409 points Bogdanp | 1 comments | | HN request time: 0.205s | source
Show context
bigstrat2003 ◴[] No.45536084[source]
Similarly, unix man pages desperately need examples. They are almost without fail written as an exhaustive reference for someone who already knows how to use the tool, which is a totally valid use case. But that means they're generally useless for someone trying to use a tool for the first time. Good documentation needs to have both.
replies(9): >>45536223 #>>45536396 #>>45536589 #>>45536670 #>>45538529 #>>45539526 #>>45539542 #>>45541440 #>>45542420 #
1. Hackbraten ◴[] No.45541440[source]
I wholeheartedly agree, and would like to remind all man page authors that there’s even a conventional section named EXAMPLE. See man(1) for details. [0]

[0] https://www.man7.org/linux/man-pages/man1/man.1.html#DESCRIP...