[Numpy-discussion] Documentation
Alan G Isaac
aisaac at american.edu
Tue May 15 12:21:48 EDT 2007
> Gary Ruben wrote:
>> In you post, is your numpy/doc reference referring to the
>> file HOWTO_DOCUMENT.txt?
>> I notice that this is not the same as the one here
>> <http://scipy.org/DocstringStandard>
>> which I think may be the preferred standard. If someone can confirm
>> this, it should probably replace the HOWTO_DOCUMENT.txt content. IMO,
>> the wiki version is more readable and also more comprehensive.
On Tue, 15 May 2007, Robert Kern apparently wrote:
> Note that despite the title, we haven't actually agreed to this format. It was
> simply a proposal.
Just to add a bit more specificity, I believe that the
HOWTO_DOCUMENT.txt document at
http://svn.scipy.org/svn/numpy/trunk/numpy/doc/HOWTO_DOCUMENT.txt
summarizes a substantial discussion and broad agreement.
I.e., it is currently the preferred standard.
Apologies if I missed a relevant discussion,
Alan Isaac
More information about the NumPy-Discussion
mailing list