diff options
| author | Michael Kerrisk <mtk.manpages@gmail.com> | 2020-09-15 09:57:23 +0200 |
|---|---|---|
| committer | Michael Kerrisk <mtk.manpages@gmail.com> | 2020-09-15 10:43:20 +0200 |
| commit | 6e6844174146d122535b8bee58440802f1ade243 (patch) | |
| tree | dd37f14f08aac2e01e1f6a1c1ff23951e7d5ae7d | |
| parent | 1aaa7bcd6a3eab5e1a2f70836fa8a76ce0701b3c (diff) | |
| download | man-pages-6e6844174146d122535b8bee58440802f1ade243.tar.gz | |
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>
| -rw-r--r-- | man7/man-pages.7 | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/man7/man-pages.7 b/man7/man-pages.7 index a721dc825..d1f24ba42 100644 --- a/man7/man-pages.7 +++ b/man7/man-pages.7 @@ -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. |