s-news
[Top] [All Lists]

Re: [S] RE: Documentation

To: Paul Gilbert <pgilbert@bank-banque-canada.ca>
Subject: Re: [S] RE: Documentation
From: Anne York <york@orca.akctr.noaa.gov>
Date: Thu, 28 May 1998 08:25:32 -0700 (PDT)
Cc: S-news <s-news@wubios.wustl.edu>
In-reply-to: <98May28.112139edt.13444@mailgate.bank-banque-canada.ca>
Sender: owner-s-news@wubios.wustl.edu
I remember being part of an "automatic way" when I was a graduate
student. 

On Thu, 28 May 1998, Paul Gilbert wrote:

... many lines deleted 

>>
>> What I would really  like is some automatic way to check if 
>> the help is correct.
>>In theory it should be possible to do some things like
>>
>>-check if documention arguments match function arguments (trivial of course if
>>help is generated from the function, but not so otherwise).
>>
>>-check that arguments are all documented.
>>
>>-check that results usually correspond to documented results.
>>
>>-check that examples work.
>>
>>-check that "see also" references actually exist.
>>
>>-check if the system is user friendly enough that documentation can be
>>eliminated.


-----------------------------------------------------------------------
This message was distributed by s-news@wubios.wustl.edu.  To unsubscribe
send e-mail to s-news-request@wubios.wustl.edu with the BODY of the
message:  unsubscribe s-news

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