On 11/17/14 01:50, Ingo Schwarze wrote:
Hi Eric,
Eric Furman wrote on Sun, Nov 16, 2014 at 11:40:49PM -0500:
OpenBSD's man pages are fantastic, but one area I have
noticed that could be improved is that some entries could
benefit from having more and/or better examples of use.
That is true. Not all manual pages are short of examples, but many
are, and some examples can be improved. People knowing areas well
such that they can distinguish good usage from cumbersome idioms
and such that they know what is important are welcome to submit
patches.
If somebody with less experience has problems understanding some
particular aspect of some particular manual and thinks that an
example might help, saying so on this list can also be helpful
because people knowing an area well often overlook problems that
less experienced users may face.
Yours,
Ingo
It's worth to note the author of a manual page may have considered not
to include examples since it could mislead from the main documentation.
In that case, the author should point to further and/or more detailed
resources.
Juan J. Fernandez
