Hi Juan,

Juan J. Fernandez wrote on Mon, Nov 17, 2014 at 03:11:51PM -0400:

> It's worth to note the author of a manual page may have considered
> not to include examples since it could mislead

You probably mean "distract"?

(I certainly agree that misleading examples should be deleted.)

> from the main documentation.  In that case, the author should point
> to further and/or more detailed resources.

I strongly disagree.

Having documentation in two places is not helpful - like, a manual
page that is unusable because it's incomplete and some other
resource (like a web site, info(1) file, or PDF document) that
is unusable because it's too wordy and takes too long to read.

The art of good reference documentation is to be complete and
concise, exact and comprehensible all at the same time and all in
the same place.

Yours,
  Ingo

Reply via email to