man-pages.7: Soften the statement that ideal programs should be short

Sometimes, a longer program is needed. See
https://twitter.com/shuveb/status/1305689727715086337.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
This commit is contained in:
Michael Kerrisk 2020-09-15 09:57:23 +02:00
parent 1aaa7bcd6a
commit 6e68441741
1 changed files with 4 additions and 2 deletions

View File

@ -943,8 +943,10 @@ description of the interface.
An example program that does nothing
other than call an interface usually serves little purpose.
.IP *
Example programs should be fairly short (preferably less than 100 lines;
ideally less than 50 lines).
Example programs should ideally be short
(e.g., a good example can often be provided in less than 100 lines of code),
though in some cases longer programs may be necessary
to properly illustrate the use of an API.
.IP *
Example programs should do error checking after system calls and
library function calls.