On Sat, Nov 03, 2018 at 02:00:51PM -0700, Sean Whitton wrote: > +It is recommended that manual pages contain an EXAMPLES section, > +containing working syntax that uses the functionality documented by > +the manual page. For example, command-line invocations of a utility > +for some of its standard usages, or an example call to an API > +function.
I'm wary of one thing: I don't really want to be bothered by this.
Going around patching upstream's manpages to add an EXAMPLE section is
totally busywork, not mention possibly even hard to do for all the
autogenerated manpages.
What I mean is: if there is really enough people wanting this change by
all means do it, but 1. make the wording clear that is really optional
(in this view, I see "recommended" as too strong a word) and 2. I really
hope lintian won't start bothering for this.
--
regards,
Mattia Rizzolo
GPG Key: 66AE 2B4A FCCF 3F52 DA18 4D18 4B04 3FCD B944 4540 .''`.
more about me: https://mapreri.org : :' :
Launchpad user: https://launchpad.net/~mapreri `. `'`
Debian QA page: https://qa.debian.org/developer.php?login=mattia `-
signature.asc
Description: PGP signature
