Re: [Numpy-discussion] Documentation roles in the numpy/scipy documentation editor

2012-05-09 Thread Joe Harrington
We considered lowering the review standard near the end of my direct involvement in the doc project but decided not to. You didn't mention any benefit to the proposed changes, so while I'm not active in the doc project anymore, let me relate our decision. It's often the case that docstrings get w

Re: [Numpy-discussion] Documentation roles in the numpy/scipy documentation editor

2012-05-07 Thread Ralf Gommers
On Mon, May 7, 2012 at 7:37 PM, Tim Cera wrote: > I think we should change the roles established for the Numpy/Scipy > documentation editors because they do not work as intended. > > For reference they are described here: > http://docs.scipy.org/numpy/Front%20Page/ > > Basically there aren't that

[Numpy-discussion] Documentation roles in the numpy/scipy documentation editor

2012-05-07 Thread Tim Cera
I think we should change the roles established for the Numpy/Scipy documentation editors because they do not work as intended. For reference they are described here: http://docs.scipy.org/numpy/Front%20Page/ Basically there aren't that many active people to support being split into the roles as d

Re: [Numpy-discussion] documentation bug: Matrix library page not populated

2012-04-23 Thread Ralf Gommers
On Mon, Apr 23, 2012 at 8:42 PM, wrote: > On Mon, Apr 23, 2012 at 2:05 PM, Ralf Gommers > wrote: > > > > > > On Thu, Apr 19, 2012 at 3:12 AM, wrote: > >> > >> On Wed, Apr 18, 2012 at 4:14 PM, Pauli Virtanen wrote: > >> > Hi, > >> > > >> > 18.04.2012 19:57, Alan G Isaac kirjoitti: > >> >> > >>

Re: [Numpy-discussion] documentation bug: Matrix library page not populated

2012-04-23 Thread josef . pktd
On Mon, Apr 23, 2012 at 2:05 PM, Ralf Gommers wrote: > > > On Thu, Apr 19, 2012 at 3:12 AM, wrote: >> >> On Wed, Apr 18, 2012 at 4:14 PM, Pauli Virtanen wrote: >> > Hi, >> > >> > 18.04.2012 19:57, Alan G Isaac kirjoitti: >> >> >> >> http://docs.scipy.org/doc/numpy/reference/routines.matlib.html#

Re: [Numpy-discussion] documentation bug: Matrix library page not populated

2012-04-23 Thread Ralf Gommers
On Thu, Apr 19, 2012 at 3:12 AM, wrote: > On Wed, Apr 18, 2012 at 4:14 PM, Pauli Virtanen wrote: > > Hi, > > > > 18.04.2012 19:57, Alan G Isaac kirjoitti: > >> > http://docs.scipy.org/doc/numpy/reference/routines.matlib.html#module-numpy.matlib > >> promises a list of functions that does not app

Re: [Numpy-discussion] documentation bug: Matrix library page not populated

2012-04-18 Thread josef . pktd
On Wed, Apr 18, 2012 at 4:14 PM, Pauli Virtanen wrote: > Hi, > > 18.04.2012 19:57, Alan G Isaac kirjoitti: >> http://docs.scipy.org/doc/numpy/reference/routines.matlib.html#module-numpy.matlib >> promises a list of functions that does not appear (at the moment, anyway). > > This doesn't seem to be

Re: [Numpy-discussion] documentation bug: Matrix library page not populated

2012-04-18 Thread Pauli Virtanen
Hi, 18.04.2012 19:57, Alan G Isaac kirjoitti: > http://docs.scipy.org/doc/numpy/reference/routines.matlib.html#module-numpy.matlib > promises a list of functions that does not appear (at the moment, anyway). This doesn't seem to be due to a technical reason, but rather than because nobody has wri

[Numpy-discussion] documentation bug: Matrix library page not populated

2012-04-18 Thread Alan G Isaac
http://docs.scipy.org/doc/numpy/reference/routines.matlib.html#module-numpy.matlib promises a list of functions that does not appear (at the moment, anyway). Alan Isaac ___ NumPy-Discussion mailing list NumPy-Discussion@scipy.org http://mail.scipy.org/ma

Re: [Numpy-discussion] Documentation question.

2012-02-02 Thread Travis Oliphant
I see your time machine is in full working order :-) -- Travis Oliphant (on a mobile) 512-826-7480 On Feb 2, 2012, at 4:18 PM, Mark Wiebe wrote: > On Wed, Feb 1, 2012 at 7:13 PM, Travis Oliphant wrote: > Hey Mark, > > I spent some quality time with your iterator docs tonight and look forwar

Re: [Numpy-discussion] Documentation question.

2012-02-02 Thread Mark Wiebe
On Wed, Feb 1, 2012 at 7:13 PM, Travis Oliphant wrote: > Hey Mark, > > I spent some quality time with your iterator docs tonight and look forward > to getting into the code a bit more soon. I wanted to get your general > impressions about what it would take to extend the iterator API to handle

Re: [Numpy-discussion] Documentation question.

2012-02-01 Thread Travis Oliphant
I believe I sent the wrong link to PDL, threading, earlier http://www.johnlapeyre.com/pdl/pdldoc/newbook/node5.html#SECTION00510 Is the explanation of threading in Perl that I was reading about. I have read about Threading earlier and really liked it's generality. I would

Re: [Numpy-discussion] Documentation question.

2012-02-01 Thread Travis Oliphant
Hey Mark, I spent some quality time with your iterator docs tonight and look forward to getting into the code a bit more soon. I wanted to get your general impressions about what it would take to extend the iterator API to handle iterating over "regions" of the inputs --- i.e. to support gen

Re: [Numpy-discussion] Documentation question.

2012-02-01 Thread Travis Oliphant
Thanks! What a great doc page. -Travis On Feb 1, 2012, at 8:31 PM, Mark Wiebe wrote: > On Wed, Feb 1, 2012 at 6:14 PM, Travis Oliphant wrote: > > On Feb 1, 2012, at 7:04 PM, Mark Wiebe wrote: > >> On Wed, Feb 1, 2012 at 3:29 PM, Charles R Harris >> wrote: >> The macro PyArray_RemoveLarges

Re: [Numpy-discussion] Documentation question.

2012-02-01 Thread Mark Wiebe
On Wed, Feb 1, 2012 at 6:14 PM, Travis Oliphant wrote: > > On Feb 1, 2012, at 7:04 PM, Mark Wiebe wrote: > > On Wed, Feb 1, 2012 at 3:29 PM, Charles R Harris < > charlesr.har...@gmail.com> wrote: > >> The macro PyArray_RemoveLargest has been replaced by >> PyArray_RemoveSmallest (which seems stra

Re: [Numpy-discussion] Documentation question.

2012-02-01 Thread Travis Oliphant
On Feb 1, 2012, at 7:04 PM, Mark Wiebe wrote: > On Wed, Feb 1, 2012 at 3:29 PM, Charles R Harris > wrote: > The macro PyArray_RemoveLargest has been replaced by PyArray_RemoveSmallest > (which seems strange), but I wonder if this documentation still makes sense. > > My impression about this c

Re: [Numpy-discussion] Documentation question.

2012-02-01 Thread Mark Wiebe
On Wed, Feb 1, 2012 at 3:29 PM, Charles R Harris wrote: > The macro PyArray_RemoveLargest has been replaced by > PyArray_RemoveSmallest (which seems strange), but I wonder if this > documentation still makes sense. > My impression about this code is that it went through a number of rounds trying

[Numpy-discussion] Documentation question.

2012-02-01 Thread Charles R Harris
The macro PyArray_RemoveLargest has been replaced by PyArray_RemoveSmallest (which seems strange), but I wonder if this documentation still makes sense. diff --git a/doc/source/user/c-info.beyond-basics.rst b/doc/source/user/ c-info.beyond-basics.rs index 9ed2ab3..3437985 100644 --- a/doc/source/u

Re: [Numpy-discussion] Documentation errors

2011-05-15 Thread Charles R Harris
On Sun, May 15, 2011 at 3:35 AM, Pauli Virtanen wrote: > On Sun, 15 May 2011 10:32:17 +0200, Ralf Gommers wrote: > >> OK, the format for that part of the signature is in line 4910 in > >> ufunc_object.c. The question is, which should we fix, the format or the > >> autosummary? > > > > The format

Re: [Numpy-discussion] Documentation errors

2011-05-15 Thread Pauli Virtanen
On Sun, 15 May 2011 10:32:17 +0200, Ralf Gommers wrote: >> OK, the format for that part of the signature is in line 4910 in >> ufunc_object.c. The question is, which should we fix, the format or the >> autosummary? > > The format please. That [, out] never made sense to me. The problem here is tha

Re: [Numpy-discussion] Documentation errors

2011-05-15 Thread Ralf Gommers
On Sun, May 15, 2011 at 6:22 AM, Charles R Harris wrote: > > > On Sat, May 14, 2011 at 10:48 AM, Pauli Virtanen wrote: > >> On Sat, 14 May 2011 09:45:12 -0600, Charles R Harris wrote: >> [clip] >> > These are generated by the .. autosummary:: command, so the error >> > probably lies there. >> >>

Re: [Numpy-discussion] Documentation errors

2011-05-14 Thread Charles R Harris
On Sat, May 14, 2011 at 10:48 AM, Pauli Virtanen wrote: > On Sat, 14 May 2011 09:45:12 -0600, Charles R Harris wrote: > [clip] > > These are generated by the .. autosummary:: command, so the error > > probably lies there. > > The problem is that the signature of these routines is written as > >

Re: [Numpy-discussion] Documentation errors

2011-05-14 Thread Charles R Harris
On Sat, May 14, 2011 at 10:48 AM, Pauli Virtanen wrote: > On Sat, 14 May 2011 09:45:12 -0600, Charles R Harris wrote: > [clip] > > These are generated by the .. autosummary:: command, so the error > > probably lies there. > > The problem is that the signature of these routines is written as > >

Re: [Numpy-discussion] Documentation errors

2011-05-14 Thread Pauli Virtanen
On Sat, 14 May 2011 09:45:12 -0600, Charles R Harris wrote: [clip] > These are generated by the .. autosummary:: command, so the error > probably lies there. The problem is that the signature of these routines is written as remainder(x1, x2[, out]) and not as remainder(x1, x2, o

[Numpy-discussion] Documentation errors

2011-05-14 Thread Charles R Harris
A number of the ufuncs in the reference doc are missing arguments, for example remainder(x1) Return element-wise remainder of division. mod(x1) Return element-wise remainder of division. fmod(x1) Return the element-wise remainder of division. absolute() Calculate the absolute value element-wise. r

Re: [Numpy-discussion] Documentation error in numpy.random.logseries

2010-06-26 Thread Vincent Davis
On Sat, Jun 26, 2010 at 3:18 PM, wrote: > On Sat, Jun 26, 2010 at 5:12 PM, Vincent Davis > wrote: >> On Sat, Jun 26, 2010 at 3:04 PM,   wrote: >>> On Sat, Jun 26, 2010 at 4:58 PM, David Goldsmith >>> wrote: On Sat, Jun 26, 2010 at 1:41 PM, Vincent Davis wrote: > > numpy.rand

Re: [Numpy-discussion] Documentation error in numpy.random.logseries

2010-06-26 Thread josef . pktd
On Sat, Jun 26, 2010 at 5:12 PM, Vincent Davis wrote: > On Sat, Jun 26, 2010 at 3:04 PM,   wrote: >> On Sat, Jun 26, 2010 at 4:58 PM, David Goldsmith >> wrote: >>> On Sat, Jun 26, 2010 at 1:41 PM, Vincent Davis >>> wrote: numpy.random.logseries(p, size=None) but the parameter

Re: [Numpy-discussion] Documentation error in numpy.random.logseries

2010-06-26 Thread Vincent Davis
On Sat, Jun 26, 2010 at 3:04 PM, wrote: > On Sat, Jun 26, 2010 at 4:58 PM, David Goldsmith > wrote: >> On Sat, Jun 26, 2010 at 1:41 PM, Vincent Davis >> wrote: >>> >>> numpy.random.logseries(p, size=None) >>> >>> but the parameters section, >>> Parameters: >>> loc : float >>> scale : float > 0.

Re: [Numpy-discussion] Documentation error in numpy.random.logseries

2010-06-26 Thread josef . pktd
On Sat, Jun 26, 2010 at 4:58 PM, David Goldsmith wrote: > On Sat, Jun 26, 2010 at 1:41 PM, Vincent Davis > wrote: >> >> numpy.random.logseries(p, size=None) >> >> but the parameters section, >> Parameters: >> loc : float >> scale : float > 0. >> size : {tuple, int} >> Output shape. If the given s

Re: [Numpy-discussion] Documentation error in numpy.random.logseries

2010-06-26 Thread David Goldsmith
On Sat, Jun 26, 2010 at 1:41 PM, Vincent Davis wrote: > numpy.random.logseries(p, size=None) > > but the parameters section, > Parameters: > loc : float > scale : float > 0. > size : {tuple, int} > Output shape. If the given shape is, e.g., (m, n, k), then m * n * k > samples are drawn. > > Notice

Re: [Numpy-discussion] Documentation error in numpy.random.logseries

2010-06-26 Thread josef . pktd
On Sat, Jun 26, 2010 at 4:47 PM, Vincent Davis wrote: > On Sat, Jun 26, 2010 at 2:41 PM, Vincent Davis > wrote: >> numpy.random.logseries(p, size=None) >> >> but the parameters section, >> Parameters: >> loc : float >> scale : float > 0. >> size : {tuple, int} >> Output shape. If the given shape

Re: [Numpy-discussion] Documentation error in numpy.random.logseries

2010-06-26 Thread Vincent Davis
On Sat, Jun 26, 2010 at 2:41 PM, Vincent Davis wrote: > numpy.random.logseries(p, size=None) > > but the parameters section, > Parameters: > loc : float > scale : float > 0. > size : {tuple, int} > Output shape. If the given shape is, e.g., (m, n, k), then m * n * k > samples are drawn. > > Notice

[Numpy-discussion] Documentation error in numpy.random.logseries

2010-06-26 Thread Vincent Davis
numpy.random.logseries(p, size=None) but the parameters section, Parameters: loc : float scale : float > 0. size : {tuple, int} Output shape. If the given shape is, e.g., (m, n, k), then m * n * k samples are drawn. Notice that p <> loc and what about scale. I'll file a ticket unless I am m

Re: [Numpy-discussion] Documentation for dtypes with named fields

2010-03-16 Thread David Goldsmith
On Tue, Mar 16, 2010 at 9:45 AM, Sam Tygier wrote: > On Tue, Mar 16, 2010 at 12:23 PM,   gmail.com> wrote: >> You can file a ticket, but if this is a function that is already in >> real use, then it would be an unpleasant break in the API > > done > http://projects.scipy.org/numpy/ticket/1431 > >

Re: [Numpy-discussion] Documentation for dtypes with named fields

2010-03-16 Thread Sam Tygier
On Tue, Mar 16, 2010 at 12:23 PM, gmail.com> wrote: > You can file a ticket, but if this is a function that is already in > real use, then it would be an unpleasant break in the API done http://projects.scipy.org/numpy/ticket/1431 thanks Sam ___ NumP

Re: [Numpy-discussion] Documentation for dtypes with named fields

2010-03-16 Thread Skipper Seabold
On Tue, Mar 16, 2010 at 12:23 PM, wrote: > On Tue, Mar 16, 2010 at 12:04 PM, Sam Tygier > wrote: >> On Tue, Mar 16, 2010 at 11:34 AM, Skipper Seabold >> wrote: so i always get the vales back in the original order. is the by design, or a bug? >>> >>> I've been bitten by this bef

Re: [Numpy-discussion] Documentation for dtypes with named fields

2010-03-16 Thread josef . pktd
On Tue, Mar 16, 2010 at 12:04 PM, Sam Tygier wrote: > On Tue, Mar 16, 2010 at 11:34 AM, Skipper Seabold wrote: >>> so i always get the vales back in the original order. is the by design, or >>> a bug? >>> >> >> I've been bitten by this before too and asked the same question with >> no response.

Re: [Numpy-discussion] Documentation for dtypes with named fields

2010-03-16 Thread josef . pktd
On Tue, Mar 16, 2010 at 12:08 PM, wrote: > On Tue, Mar 16, 2010 at 11:52 AM, Skipper Seabold wrote: >> On Tue, Mar 16, 2010 at 11:46 AM,   wrote: >>> On Tue, Mar 16, 2010 at 11:34 AM, Skipper Seabold >>> wrote: On Tue, Mar 16, 2010 at 11:20 AM, Sam Tygier wrote: > Thanks for tho

Re: [Numpy-discussion] Documentation for dtypes with named fields

2010-03-16 Thread josef . pktd
On Tue, Mar 16, 2010 at 11:52 AM, Skipper Seabold wrote: > On Tue, Mar 16, 2010 at 11:46 AM,   wrote: >> On Tue, Mar 16, 2010 at 11:34 AM, Skipper Seabold >> wrote: >>> On Tue, Mar 16, 2010 at 11:20 AM, Sam Tygier >>> wrote: Thanks for those responses. could the dtype pages in th

Re: [Numpy-discussion] Documentation for dtypes with named fields

2010-03-16 Thread Sam Tygier
On Tue, Mar 16, 2010 at 11:34 AM, Skipper Seabold wrote: >> so i always get the vales back in the original order. is the by design, or a >> bug? >> > > I've been bitten by this before too and asked the same question with > no response. I think it's just a limitation of the design of > structured

Re: [Numpy-discussion] Documentation for dtypes with named fields

2010-03-16 Thread Skipper Seabold
On Tue, Mar 16, 2010 at 11:46 AM, wrote: > On Tue, Mar 16, 2010 at 11:34 AM, Skipper Seabold wrote: >> On Tue, Mar 16, 2010 at 11:20 AM, Sam Tygier >> wrote: >>> Thanks for those responses. >>> >>> could the dtype pages in the numpy reference link to the basics.rec page in >>> the user guide?

Re: [Numpy-discussion] Documentation for dtypes with named fields

2010-03-16 Thread Skipper Seabold
On Tue, Mar 16, 2010 at 11:34 AM, Skipper Seabold wrote: > On Tue, Mar 16, 2010 at 11:20 AM, Sam Tygier > wrote: >> Thanks for those responses. >> >> could the dtype pages in the numpy reference link to the basics.rec page in >> the user guide? >> >> there seem to be some gotchas in list within

Re: [Numpy-discussion] Documentation for dtypes with named fields

2010-03-16 Thread josef . pktd
On Tue, Mar 16, 2010 at 11:34 AM, Skipper Seabold wrote: > On Tue, Mar 16, 2010 at 11:20 AM, Sam Tygier > wrote: >> Thanks for those responses. >> >> could the dtype pages in the numpy reference link to the basics.rec page in >> the user guide? >> >> there seem to be some gotchas in list within

Re: [Numpy-discussion] Documentation for dtypes with named fields

2010-03-16 Thread Skipper Seabold
On Tue, Mar 16, 2010 at 11:20 AM, Sam Tygier wrote: > Thanks for those responses. > > could the dtype pages in the numpy reference link to the basics.rec page in > the user guide? > > there seem to be some gotchas in list within a list notation. > > if i have > a = array([0,0.1,0.2,0.3,0.4]) > b

Re: [Numpy-discussion] Documentation for dtypes with named fields

2010-03-16 Thread Sam Tygier
Thanks for those responses. could the dtype pages in the numpy reference link to the basics.rec page in the user guide? there seem to be some gotchas in list within a list notation. if i have a = array([0,0.1,0.2,0.3,0.4]) b = array((0,0.1,0.2,0.3,0.4), dtype=[('a','f'), ('b','f'), ('c','f'),

Re: [Numpy-discussion] Documentation for dtypes with named fields

2010-03-16 Thread josef . pktd
On Tue, Mar 16, 2010 at 8:47 AM, Sam Tygier wrote: > Hello > > I can't find much documentation for using arrays where the dtype has named > fields (is there a term for this sort of array). there is some in > http://docs.scipy.org/doc/numpy/reference/arrays.dtypes.html > http://docs.scipy.org/doc/

Re: [Numpy-discussion] Documentation for dtypes with named fields

2010-03-16 Thread Skipper Seabold
On Tue, Mar 16, 2010 at 8:47 AM, Sam Tygier wrote: > Hello > > I can't find much documentation for using arrays where the dtype has named > fields (is there a term for this sort of array). there is some in Structured array (or record array if you make a record array -- the difference is record a

[Numpy-discussion] Documentation for dtypes with named fields

2010-03-16 Thread Sam Tygier
Hello I can't find much documentation for using arrays where the dtype has named fields (is there a term for this sort of array). there is some in http://docs.scipy.org/doc/numpy/reference/arrays.dtypes.html http://docs.scipy.org/doc/numpy/reference/generated/numpy.dtype.html but that's most crea

Re: [Numpy-discussion] documentation translation

2009-08-13 Thread Robert Kern
On Thu, Aug 13, 2009 at 14:59, Dokuro wrote: > Hello, we have a python group in Maracaibo Venezuela and have started > a translation project for as many python documentations we can find > from english to spanish, making the use of python easier to > non-english speakers, so in behalf of our group

[Numpy-discussion] documentation translation

2009-08-13 Thread Dokuro
Hello, we have a python group in Maracaibo Venezuela and have started a translation project for as many python documentations we can find from english to spanish, making the use of python easier to non-english speakers, so in behalf of our group i would like to ask if it won't be a problem if we ma

Re: [Numpy-discussion] documentation suggestion

2009-04-13 Thread Pauli Virtanen
Sun, 12 Apr 2009 17:32:31 -0400, Neal Becker wrote: [clip] > Done, but can someone check that what I wrote is accurate? I wrote that > changes to the ndarray will change the underlying buffer object. But, > the buffer protocol allows for read-only buffers. Not sure what ndarray > would do if you

Re: [Numpy-discussion] documentation suggestion

2009-04-12 Thread Neal Becker
Stéfan van der Walt wrote: > Hi Neal > > 2009/4/11 Neal Becker : >> I found this misleading. It isn't just used to _fill_ the array - it is >> the > > Please create an account on docs.scipy.org, then I'll give you > priviledges to edit documentation. > > Thanks! > Stéfan Done, but can someone

Re: [Numpy-discussion] documentation suggestion

2009-04-11 Thread Stéfan van der Walt
Hi Neal 2009/4/11 Neal Becker : > I found this misleading.  It isn't just used to _fill_ the array - it is the Please create an account on docs.scipy.org, then I'll give you priviledges to edit documentation. Thanks! Stéfan ___ Numpy-discussion mailing

[Numpy-discussion] documentation suggestion

2009-04-11 Thread Neal Becker
numpy.ndarray says: buffer : object exposing buffer interface, optional Used to fill the array with data. I found this misleading. It isn't just used to _fill_ the array - it is the actual storage for the array. If set to an object exporting the buffer interface, any updates to the ndarray wi

Re: [Numpy-discussion] Documentation: objects.inv ?

2009-01-29 Thread Scott Sinclair
> 2009/1/29 Pierre GM : > Pauli, how often is the documentation on docs.scipy.org updated from > SVN ? My understanding is the following: SVN -> doc-wiki - updated once daily at around 10:00 (UTC?). doc-wiki -> SVN - infrequently, when someone applies one or more doc patches produced from the doc

Re: [Numpy-discussion] Documentation: objects.inv ?

2009-01-29 Thread Pierre GM
On Jan 29, 2009, at 3:17 AM, Pauli Virtanen wrote: > Thu, 29 Jan 2009 00:28:46 -0500, Pierre GM wrote: >> Is there an objects.inv lying around for the numpy reference guide, >> or >> should I start one from scratch ? > > It's automatically generated by Sphinx, and can be found at > > http

Re: [Numpy-discussion] Documentation: objects.inv ?

2009-01-29 Thread Pauli Virtanen
Thu, 29 Jan 2009 00:28:46 -0500, Pierre GM wrote: > Is there an objects.inv lying around for the numpy reference guide, or > should I start one from scratch ? It's automatically generated by Sphinx, and can be found at http://docs.scipy.org/doc/numpy/objects.inv Let's make the promise th

[Numpy-discussion] Documentation: objects.inv ?

2009-01-28 Thread Pierre GM
All, Is there an objects.inv lying around for the numpy reference guide, or should I start one from scratch ? Thx a lot in advance P. ___ Numpy-discussion mailing list Numpy-discussion@scipy.org http://projects.scipy.org/mailman/listinfo/numpy-discussi

[Numpy-discussion] Documentation: glossary and refactoring

2008-07-17 Thread Stéfan van der Walt
Hi all, We recenty added a framework for topical documentation to NumPy, which is visible as `numpy.doc`. The content is here: http://sd-2116.dedibox.fr/pydocweb/doc/numpy.doc/ I think new users will find the glossary especially useful: http://sd-2116.dedibox.fr/pydocweb/doc/numpy.doc.referenc

Re: [Numpy-discussion] Documentation: topical docs and reviewing our work

2008-07-09 Thread Robert Kern
On Wed, Jul 9, 2008 at 03:28, Stéfan van der Walt <[EMAIL PROTECTED]> wrote: > Please log in and leave comments on those. Your input would be much > appreciated! Each docstring page could use a "Next" link to move to the next docstring with the same review status (actually, the same review status

[Numpy-discussion] Documentation: topical docs and reviewing our work

2008-07-09 Thread Stéfan van der Walt
Hi all, A `numpy.doc` sub-module has been added, which contains documentation for topics such as indexing, broadcasting, array operations etc. These can be edited from the documentation wiki: http://sd-2116.dedibox.fr/pydocweb/doc/numpy.doc/ If you'd like to document a topic that is not there, l

Re: [Numpy-discussion] documentation for masked arrays?

2008-03-20 Thread Chris Withers
Jarrod Millman wrote: > > There is a documentation day on Friday. If you have some time, it > would be great if you could help out with writing NumPy docstrings. > There more people who contribute, the faster this will happen. It's a catch 22, I don't have the knowledge to usefully do this :-(

Re: [Numpy-discussion] documentation for masked arrays?

2008-03-20 Thread Jarrod Millman
On Wed, Mar 19, 2008 at 8:45 AM, Chris Withers <[EMAIL PROTECTED]> wrote: > That's not been my experience. I found the *one* mention of fill_value > just fine, the coverage of masked arrays is woeful :-( There is a documentation day on Friday. If you have some time, it would be great if you cou

Re: [Numpy-discussion] documentation for masked arrays?

2008-03-19 Thread Chris Withers
Bill Spotz wrote: > I have found that any search on that document containing an > underscore will turn up zero matches. Substitute a space instead. That's not been my experience. I found the *one* mention of fill_value just fine, the coverage of masked arrays is woeful :-( Chris -- Simplist

Re: [Numpy-discussion] documentation for masked arrays?

2008-03-19 Thread Bill Spotz
I have found that any search on that document containing an underscore will turn up zero matches. Substitute a space instead. On Mar 19, 2008, at 5:02 AM, Chris Withers wrote: > Where can I find docs for masked arrays? > The "paid for" book doesn't even contain the phrase "masked_where" :-( *

[Numpy-discussion] documentation for masked arrays?

2008-03-19 Thread Chris Withers
Hi All, Where can I find docs for masked arrays? The "paid for" book doesn't even contain the phrase "masked_where" :-( cheers, Chris -- Simplistix - Content Management, Zope & Python Consulting - http://www.simplistix.co.uk ___ Numpy-dis

Re: [Numpy-discussion] documentation generator based on pyparsing

2007-11-30 Thread Nils Wagner
On Fri, 30 Nov 2007 09:48:09 +0100 Robert Cimrman <[EMAIL PROTECTED]> wrote: > Nils Wagner wrote: >> Thank you for your note. It works fine for me with >> python2.5. However python2.3 results in >> >> ./gendocs.py -m 'scipy.linsolve.umfpack' >> Traceback (most recent call last): >>File "./g

Re: [Numpy-discussion] documentation generator based on pyparsing

2007-11-30 Thread Robert Cimrman
Nils Wagner wrote: > Thank you for your note. It works fine for me with > python2.5. However python2.3 results in > > ./gendocs.py -m 'scipy.linsolve.umfpack' > Traceback (most recent call last): >File "./gendocs.py", line 261, in ? > main() >File "./gendocs.py", line 207, in main >

Re: [Numpy-discussion] documentation generator based on pyparsing

2007-11-29 Thread Nils Wagner
On Thu, 29 Nov 2007 10:01:26 +0100 Robert Cimrman <[EMAIL PROTECTED]> wrote: > Hi Nils, > > Nils Wagner wrote: >> The output of >> >> ./gendocs.py -m 'scipy.linsolve.umfpack' >> >> differs from your example output (available at >> http://scipy.org/Generate_Documentation) > > I had to update t

Re: [Numpy-discussion] documentation generator based on pyparsing

2007-11-29 Thread Robert Cimrman
Hi Nils, Nils Wagner wrote: > The output of > > ./gendocs.py -m 'scipy.linsolve.umfpack' > > differs from your example output (available at > http://scipy.org/Generate_Documentation) I had to update the umfpack info.py file (where the module docstring is) to conform the documentation standards

Re: [Numpy-discussion] documentation generator based on pyparsing

2007-11-28 Thread Nils Wagner
On Wed, 28 Nov 2007 11:29:20 +0100 Robert Cimrman <[EMAIL PROTECTED]> wrote: > Hi, > > At http://scipy.org/Generate_Documentation you can find >a very small > documentation generator for NumPy/SciPy modules based on >pyparsing > package (by Paul McGuire). I am not sure if this belongs >to w

[Numpy-discussion] documentation generator based on pyparsing

2007-11-28 Thread Robert Cimrman
Hi, At http://scipy.org/Generate_Documentation you can find a very small documentation generator for NumPy/SciPy modules based on pyparsing package (by Paul McGuire). I am not sure if this belongs to where I put it, so feel free to (re)move the page as needed. I hope it might be interesting fo

[Numpy-discussion] Documentation

2007-09-12 Thread Charles R Harris
Hi All, While doing documentation, I've run into the need for a simple word to express the fact that a variable can be an array, or anything that can be converted to an array using asarray(). I have been using array_like for this kind of variable, but I am open to suggestions. Also, the current v

Re: [Numpy-discussion] Documentation

2007-05-18 Thread Robert Kern
Alan G Isaac wrote: > I hope this is not too off topic. It seems that there is at > least one question for Enthought here: > since epydoc has the MIT license, > why not work on making epydoc traits aware instead of > developing endo separately? We are not developing endo. It was written some t

Re: [Numpy-discussion] Documentation

2007-05-18 Thread Alan G Isaac
On Fri, 18 May 2007, Charles R Harris apparently wrote: > reST seems to be compatible with all three programs, so > that is an excellent base. What I am searching for is some > consensus as to what the documentation template should > look like. I hope this is not too off topic. It seems that

Re: [Numpy-discussion] Documentation

2007-05-18 Thread Charles R Harris
On 5/18/07, Alan G Isaac <[EMAIL PROTECTED]> wrote: On Fri, 18 May 2007, Charles R Harris apparently wrote: > There now seem to be three different document creation programs: pydoc, > epydoc, and endo. Does anyone know how compatible these all are? I think it > would be best to go with the most

Re: [Numpy-discussion] Documentation

2007-05-18 Thread Alan G Isaac
On Fri, 18 May 2007, Charles R Harris apparently wrote: > There now seem to be three different document creation programs: pydoc, > epydoc, and endo. Does anyone know how compatible these all are? I think it > would be best to go with the most widespread program that looks like it will > be mai

Re: [Numpy-discussion] Documentation

2007-05-18 Thread Charles R Harris
On 5/14/07, Travis Vaught <[EMAIL PROTECTED]> wrote: Just to be thorough... enthought's endo package generates the attached docs when running this: python ~/svnrepos/enthought/src/lib/enthought/endo/scripts/endo.py -r core -p core --rst -d docs I don't want to confuse the numpy documentatio

Re: [Numpy-discussion] Documentation

2007-05-15 Thread Charles R Harris
On 5/15/07, Alan G Isaac <[EMAIL PROTECTED]> wrote: On Tue, 15 May 2007, Charles R Harris apparently wrote: > What I would like it to look like, except for the type > stuff, is attached. Ooof! Aside from obviously agreeing with the location of notes and examples, I have to say, the readability

Re: [Numpy-discussion] Documentation

2007-05-15 Thread Alan G Isaac
On Tue, 15 May 2007, Charles R Harris apparently wrote: > What I would like it to look like, except for the type > stuff, is attached. Ooof! Aside from obviously agreeing with the location of notes and examples, I have to say, the readability of your example is greatly reduced from the epydoc

Re: [Numpy-discussion] Documentation

2007-05-15 Thread Charles R Harris
On 5/15/07, Alan G Isaac <[EMAIL PROTECTED]> wrote: On Tue, 15 May 2007, Charles R Harris apparently wrote: > The item in a consolidated list is divided into three > parts: name, type, explanation. I see no way in the CSS to > control the display of those parts, although it might be > an undocum

Re: [Numpy-discussion] Documentation

2007-05-15 Thread Alan G Isaac
On Tue, 15 May 2007, Charles R Harris apparently wrote: > The item in a consolidated list is divided into three > parts: name, type, explanation. I see no way in the CSS to > control the display of those parts, although it might be > an undocumented feature. I basically want it to look like >

Re: [Numpy-discussion] Documentation

2007-05-15 Thread Charles R Harris
On 5/15/07, Charles R Harris <[EMAIL PROTECTED]> wrote: On 5/15/07, Alan G Isaac <[EMAIL PROTECTED]> wrote: > > On Tue, 15 May 2007, Charles R Harris apparently wrote: > > If a CSS can set all the font styles, item spacing, and > > treatment of explanatory text, that would be the more > > flex

Re: [Numpy-discussion] Documentation

2007-05-15 Thread Alan G Isaac
On Tue, 15 May 2007, Charles R Harris apparently wrote: > Looks like the font used for section headings can be > specified, but there is nothing in the epydoc.css file > that looks like it affects the consolidated lists or the > movement of a section heading to the top of the output. > I think

Re: [Numpy-discussion] Documentation

2007-05-15 Thread Charles R Harris
On 5/15/07, Alan G Isaac <[EMAIL PROTECTED]> wrote: On Tue, 15 May 2007, Charles R Harris apparently wrote: > If a CSS can set all the font styles, item spacing, and > treatment of explanatory text, that would be the more > flexible route. I'm not sure what "treatment" meams here, but if it is

Re: [Numpy-discussion] Documentation

2007-05-15 Thread Charles R Harris
On 5/15/07, Gael Varoquaux <[EMAIL PROTECTED]> wrote: On Tue, May 15, 2007 at 01:15:12PM -0400, Alan G Isaac wrote: > Bullets in consolidated lists: > if you don't like them, don't use them. > Use a definition list instead. > (I like this much better myself.) Can't this be fixed by

Re: [Numpy-discussion] Documentation

2007-05-15 Thread Alan G Isaac
On Tue, 15 May 2007, Charles R Harris apparently wrote: > If a CSS can set all the font styles, item spacing, and > treatment of explanatory text, that would be the more > flexible route. I'm not sure what "treatment" meams here, but if it is a matter of font decisions or spacing, the answer sh

Re: [Numpy-discussion] Documentation

2007-05-15 Thread Charles R Harris
On 5/15/07, Alan G Isaac <[EMAIL PROTECTED]> wrote: > On Tue, May 15, 2007 at 01:15:12PM -0400, Alan G Isaac wrote: >> Bullets in consolidated lists: >> if you don't like them, don't use them. >> Use a definition list instead. >> (I like this much better myself.) On Tue, 15 May 200

Re: [Numpy-discussion] Documentation

2007-05-15 Thread Alan G Isaac
> On Tue, May 15, 2007 at 01:15:12PM -0400, Alan G Isaac wrote: >> Bullets in consolidated lists: >> if you don't like them, don't use them. >> Use a definition list instead. >> (I like this much better myself.) On Tue, 15 May 2007, Gael Varoquaux apparently wrote: > Can't this

Re: [Numpy-discussion] Documentation

2007-05-15 Thread Gael Varoquaux
On Tue, May 15, 2007 at 01:15:12PM -0400, Alan G Isaac wrote: > Bullets in consolidated lists: > if you don't like them, don't use them. > Use a definition list instead. > (I like this much better myself.) Can't this be fixed by a CSS ? Gaël ___

Re: [Numpy-discussion] Documentation

2007-05-15 Thread Alan G Isaac
On Tue, 15 May 2007, Charles R Harris apparently wrote: > It also causes the headings to be set in large bold type. Ugly. Well I agree. But again this is just a style issue. All font decisions (and *much* else) can be set in a CSS file. > I think reST is great, and properly used we get good >

Re: [Numpy-discussion] Documentation

2007-05-15 Thread Charles R Harris
On 5/15/07, Alan G Isaac <[EMAIL PROTECTED]> wrote: > On 5/15/07, Alan G Isaac <[EMAIL PROTECTED]> wrote: >> 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 d

Re: [Numpy-discussion] Documentation

2007-05-15 Thread Alan G Isaac
> On 5/15/07, Alan G Isaac <[EMAIL PROTECTED]> wrote: >> 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 cur

Re: [Numpy-discussion] Documentation

2007-05-15 Thread Charles R Harris
On 5/15/07, Charles R Harris <[EMAIL PROTECTED]> wrote: On 5/15/07, Alan G Isaac <[EMAIL PROTECTED]> wrote: > > > 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:/

Re: [Numpy-discussion] Documentation

2007-05-15 Thread Charles R Harris
On 5/15/07, Alan G Isaac <[EMAIL PROTECTED]> wrote: > 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 >> >> which I think may be the preferred sta

Re: [Numpy-discussion] Documentation

2007-05-15 Thread Alan G Isaac
> 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 >> >> which I think may be the preferred standard. If someone can confirm >> this, it should

Re: [Numpy-discussion] Documentation

2007-05-15 Thread Robert Kern
Gary Ruben wrote: > Hi Charles, > > 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 > > which I think may be the preferred standard. If someone can confirm > this, it

Re: [Numpy-discussion] Documentation

2007-05-15 Thread Charles R Harris
On 5/15/07, Gary Ruben <[EMAIL PROTECTED]> wrote: Hi Charles, 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 which I think may be the preferred standard. If someone can c

Re: [Numpy-discussion] Documentation

2007-05-15 Thread Gary Ruben
Hi Charles, 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 which I think may be the preferred standard. If someone can confirm this, it should probably replace the HOWTO_D

Re: [Numpy-discussion] Documentation examples with doc

2007-04-30 Thread Robert Kern
Martin Blais wrote: > Hi > > Where is the script that generates the Numpy Examples with Doc on the > scipy website? > I cannot find it in the numpy svn. > Maybe I would like to create a version that generates LaTeX for > Python-style documentation. I find searching through this big web > page a s

  1   2   >