Email List: Xaustin-group-lX
[All Lists]

RE: Adding more examples to the man pages

To: "Joe Gwinn" <yyyyyyyy@xxxxxxxxx>, "Andrew Josey" <yyyyyy@xxxxxxxxxxxxxxxxx>
Subject: RE: Adding more examples to the man pages
From: "Jason Zions" <yyyyyyyy@xxxxxxxxxxxxxxxxxxx>
Date: Fri, 27 Jun 2003 09:56:31 -0700
Cc: <yyyyyyyyyyyyyy@xxxxxxxxxxxxx>
Thread-index: AcM8tM/PUgmrGQCKRqKihmuim4CAWQAF9WHg
Thread-topic: Adding more examples to the man pages
>>Criteria is  they should be conforming extracts of code.
>>and illustrative of key concepts.  They do not have to be complete 
>>working code with full error checking.
>
>One would hope that the examples would all be tested and shown to work,
>though.  They just don't need to be practical, in the sense that proper
>error handling isn't needed.

Bitter experience shows that people take examples and sample code and
drop them into applications as-is. I believe you do a disservice to
developers and to the users of the applications they develop if you
publish samples that don't do proper error checking. Especially since
there are subtleties in error checking and handling for some (many?)
UNIX calls.

Jason

<Prev in Thread] Current Thread [Next in Thread>