control: tag -1 +patch Hello, Policy probably shouldn't contain too much detail about the contents of manpages, but EXAMPLES sections really do make them significantly more useful, so I would like to include the recommendation that Shirish proposes. Hence I am seeking seconds for this patch I've written: diff --git a/policy/ch-docs.rst b/policy/ch-docs.rst index e990f34..a9b297f 100644 --- a/policy/ch-docs.rst +++ b/policy/ch-docs.rst @@ -61,6 +61,12 @@ by a note at the beginning of the manual page or by showing the missing or changed portions in the original language instead of the target language. +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. + .. _s12.2: Info documents -- Sean Whitton
Attachment:
signature.asc
Description: PGP signature