Re: [Numpy-discussion] [SciPy-dev] Doc-day

2007-12-30 Thread Alan G Isaac
On Sat, 29 Dec 2007, "Travis E. Oliphant" apparently wrote: > they make it so that the documentation standard for SciPy > and NumPy is not different from the ETS standard 1. Is the Enthought Tool Suite standard published? 2. I think it miscasts things to say that the previous standard was buil

Re: [Numpy-discussion] [SciPy-dev] Doc-day

2007-12-29 Thread Travis E. Oliphant
Charles R Harris wrote: > > > On Dec 29, 2007 7:59 PM, Fernando Perez <[EMAIL PROTECTED] > > wrote: > > On Dec 29, 2007 6:51 PM, Charles R Harris > <[EMAIL PROTECTED] > wrote: > > > If not, we should > > definitely decide on the s

Re: [Numpy-discussion] [SciPy-dev] Doc-day

2007-12-29 Thread Charles R Harris
On Dec 29, 2007 7:59 PM, Fernando Perez <[EMAIL PROTECTED]> wrote: > On Dec 29, 2007 6:51 PM, Charles R Harris <[EMAIL PROTECTED]> > wrote: > > > If not, we should > > definitely decide on the structure of the docstrings and stick to it. > > +100 > I have raised the topic of documentation formats

Re: [Numpy-discussion] [SciPy-dev] Doc-day

2007-12-29 Thread Fernando Perez
On Dec 29, 2007 6:51 PM, Charles R Harris <[EMAIL PROTECTED]> wrote: > If not, we should > definitely decide on the structure of the docstrings and stick to it. +100 I'm about to commit docstrings for scimath (what I started yesterday). After some fixes to the numpy build, I can now work in-pla

Re: [Numpy-discussion] [SciPy-dev] Doc-day

2007-12-29 Thread Charles R Harris
On Dec 28, 2007 5:26 AM, Stefan van der Walt <[EMAIL PROTECTED]> wrote: > On Thu, Dec 27, 2007 at 09:27:09PM -0800, Jarrod Millman wrote: > > On Dec 27, 2007 7:42 PM, Travis E. Oliphant <[EMAIL PROTECTED]> > wrote: > > > Doc-day will start tomorrow (in about 12 hours). It will be Friday > for > >

Re: [Numpy-discussion] [SciPy-dev] Doc-day

2007-12-28 Thread Stefan van der Walt
On Fri, Dec 28, 2007 at 11:32:03AM -0600, Travis E. Oliphant wrote: > I don't see the point in every file having a __docformat__ line, when > our documentaion formatting tool should already know the standard we are > using is. It's just more cruft. Besides the PEP was rejected, so I > don't

Re: [Numpy-discussion] [SciPy-dev] Doc-day

2007-12-28 Thread Fernando Perez
On Dec 28, 2007 12:55 PM, Robert Kern <[EMAIL PROTECTED]> wrote: > Matthieu Brucher wrote: > > Matthew B. will be working on converting SciPy tests to use nose per > > Fernando's email. If you are familiar with nose and want to help, > > please make sure to check with Matthew or Fernan

Re: [Numpy-discussion] [SciPy-dev] Doc-day

2007-12-28 Thread Robert Kern
Matthieu Brucher wrote: > Matthew B. will be working on converting SciPy tests to use nose per > Fernando's email. If you are familiar with nose and want to help, > please make sure to check with Matthew or Fernando first. > > > I must have missed Fernando's email because I can't fin

Re: [Numpy-discussion] [SciPy-dev] Doc-day

2007-12-28 Thread Travis E. Oliphant
Stefan van der Walt wrote: > On Thu, Dec 27, 2007 at 09:27:09PM -0800, Jarrod Millman wrote: > >> On Dec 27, 2007 7:42 PM, Travis E. Oliphant <[EMAIL PROTECTED]> wrote: >> >>> Doc-day will start tomorrow (in about 12 hours). It will be Friday for >>> much of America and be moving into Satu

Re: [Numpy-discussion] [SciPy-dev] Doc-day

2007-12-28 Thread Matthieu Brucher
> > Matthew B. will be working on converting SciPy tests to use nose per > Fernando's email. If you are familiar with nose and want to help, > please make sure to check with Matthew or Fernando first. > I must have missed Fernando's email because I can't find the references for nose :( What are i

Re: [Numpy-discussion] [SciPy-dev] Doc-day

2007-12-28 Thread Stefan van der Walt
On Thu, Dec 27, 2007 at 09:27:09PM -0800, Jarrod Millman wrote: > On Dec 27, 2007 7:42 PM, Travis E. Oliphant <[EMAIL PROTECTED]> wrote: > > Doc-day will start tomorrow (in about 12 hours). It will be Friday for > > much of America and be moving into Saturday for Europe and Asia. Join > > in on t

Re: [Numpy-discussion] [SciPy-dev] Doc-day

2007-12-28 Thread Fernando Perez
Since I won't be able to participate tomorrow, here's a small contribution. I just added this to ipython: http://projects.scipy.org/ipython/ipython/browser/ipython/trunk/IPython/dtutils.py You can load it in your startup file or interactively via from IPython.dtutils import idoctest Type idoct

Re: [Numpy-discussion] [SciPy-dev] Doc-day

2007-12-27 Thread Fernando Perez
On Dec 27, 2007 10:50 PM, Jarrod Millman <[EMAIL PROTECTED]> wrote: > > I also think that the above wiki page should have a minimal, > > self-contained example of a proper docstring with all 8 sections > > implemented. I'm honestly not sure at this point what the actual > > changes to epydoc are

Re: [Numpy-discussion] [SciPy-dev] Doc-day

2007-12-27 Thread Jarrod Millman
On Dec 27, 2007 9:41 PM, Fernando Perez <[EMAIL PROTECTED]> wrote: > Care to make the Example section mandatory, instead of optional? I > really think it should be mandatory. We may not do a good job of it > initially, but at least we should express that it's of critical > importance that every f

Re: [Numpy-discussion] [SciPy-dev] Doc-day

2007-12-27 Thread Fernando Perez
On Dec 27, 2007 10:27 PM, Jarrod Millman <[EMAIL PROTECTED]> wrote: > Since this is our first doc-day, it will be fairly informal. Travis > is going to be trying to get some estimate of which packages need the > most work. But if there is some area of NumPy or SciPy you are > familiar with, plea

Re: [Numpy-discussion] [SciPy-dev] Doc-day

2007-12-27 Thread Jarrod Millman
On Dec 27, 2007 7:42 PM, Travis E. Oliphant <[EMAIL PROTECTED]> wrote: > Doc-day will start tomorrow (in about 12 hours). It will be Friday for > much of America and be moving into Saturday for Europe and Asia. Join > in on the irc.freenode.net (channel scipy) to coordinate effort. I > imaging