Mailman 3 June 2009 - SciPy-Dev

Re: [SciPy-dev] Documenting Warnings
by David Goldsmith June 27, 2009

June 27, 2009

Personally, I think under Notes - with suitable emphasis, e.g., bracketed w/ double *'s, i.e., **Warning:** - would suffice. However, if it did exist in the standard and was removed, perhaps a summary of why could be added to the FAQ. DG --- On Fri, 6/26/09, Pierre GM <pgmdevlist(a)gmail.com> wrote: > From: Pierre GM <pgmdevlist(a)gmail.com> > Subject: Re: [SciPy-dev] Documenting Warnings > To: "SciPy Developers List" <scipy-dev(a)scipy.org> > Date: Friday, June 26, 2009, 2:03 PM > > On Jun 26, 2009, at 4:48 PM, Ralf Gommers wrote: > > > > > > > On Fri, Jun 26, 2009 at 3:24 PM, Pierre GM <pgmdevlist(a)gmail.com> > > > wrote: > > All, > > How do we document a warning, a note that should be > displayed > > differently as a note ? Don't we have a "Warnings" > entry in the > > docstrings standard ? > > Thx > > > > > For longer reST doc files you can use (see for example > http://docs.scipy.org/numpy/docs/numpy-docs/user/index.rst/) > > > : > > > > .. warning:: > > > > Description. > > Meh. Not the best as you pointed out. > > > > There is no Warnings heading in the docstring > standard. > > I've noticed that and regret it. > > > Why can't you put it either under Notes or under > Raises? > > Because you may want to stress one particular aspect that > would > otherwise be easy to overlook in a Notes. Because you want > to describe > a known limitation that doesn't raise any exception (and > maybe not > even a warning per se: in that case, I'd put in the Raises > section as > you suggest). > > [FYI, I was just checking recent updates in the docstrings > of numpy.ma > and noticed that Pauli got rid of the Warnings section and > merged it > in a Notes. I still think that the two sections shouldn't > have been > merged, but I won't lose sleep over it. I'm just curious). > > > > And special reST markup like the above is discouraged > in docstrings > > because it looks bad on text terminals. > > So why don't we have a Warning entry in the docsring > standard ? Pauli, > what are your thoughts about that ? I know for a fact that > it'd be > quite easy to implement. Any strong reason against that ? > > _______________________________________________ > Scipy-dev mailing list > Scipy-dev(a)scipy.org > http://mail.scipy.org/mailman/listinfo/scipy-dev >

5 4

Documenting Warnings
by Pierre GM June 27, 2009

June 27, 2009

All, How do we document a warning, a note that should be displayed differently as a note ? Don't we have a "Warnings" entry in the docstrings standard ? Thx

3 3

SciPy abstract submission deadline extended
by Gael Varoquaux June 27, 2009

June 27, 2009

Greetings, The conference committee is extending the deadline for abstract submission for the Scipy conference 2009 one week. On Friday July 3th, at midnight Pacific, we will turn off the abstract submission on the conference site. Up to then, you can modify the already-submitted abstract, or submit new abstracts. Submitting Papers --------------------- The program features tutorials, contributed papers, lightning talks, and bird-of-a-feather sessions. We are soliciting talks and accompanying papers (either formal academic or magazine-style articles) that discuss topics which center around scientific computing using Python. These include applications, teaching, future development directions, and research. A collection of peer-reviewed articles will be published as part of the proceedings. Proposals for talks are submitted as extended abstracts. There are two categories of talks: Paper presentations These talks are 35 minutes in duration (including questions). A one page abstract of no less than 500 words (excluding figures and references) should give an outline of the final paper. Proceeding papers are due two weeks after the conference, and may be in a formal academic style, or in a more relaxed magazine-style format. Rapid presentations These talks are 10 minutes in duration. An abstract of between 300 and 700 words should describe the topic and motivate its relevance to scientific computing. In addition, there will be an open session for lightning talks during which any attendee willing to do so is invited to do a couple-of-minutes-long presentation. If you wish to present a talk at the conference, please create an account on the website (http://conference.scipy.org). You may then submit an abstract by logging in, clicking on your profile and following the "Submit an abstract" link. Submission Guidelines * Submissions should be uploaded via the online form. * Submissions whose main purpose is to promote a commercial product or service will be refused. * All accepted proposals must be presented at the SciPy conference by at least one author. * Authors of an accepted proposal can provide a final paper for publication in the conference proceedings. Final papers are limited to 7 pages, including diagrams, figures, references, and appendices. The papers will be reviewed to help ensure the high-quality of the proceedings. For further information, please visit the conference homepage: http://conference.scipy.org. The SciPy 2009 executive committee ----------------------------------- * Jarrod Millman, UC Berkeley, USA (Conference Chair) * Gaël Varoquaux, INRIA Saclay, France (Program Co-Chair) * Stéfan van der Walt, University of Stellenbosch, South Africa (Program Co-Chair) * Fernando Pérez, UC Berkeley, USA (Tutorial Chair)

1 0

Marathon category of the week...
by David Goldsmith June 26, 2009

June 26, 2009

And the winner is...polynomials! I'll make a note on the Milestones page. Feel free to add yourself either as a leader or a helper if you like (though you don't need to do so, to participate, obviously). Again, the idea is that this will motivate us to "finish" this category by next Wednesday's Skypecon. Happy doc-ing! :-) DG

1 0

Re: [SciPy-dev] Definition of class multiarray
by David Goldsmith June 26, 2009

June 26, 2009

--- On Fri, 6/26/09, Robert Kern <robert.kern(a)gmail.com> wrote: > Goldsmith<d_l_goldsmith(a)yahoo.com> > wrote: > > > > OK, tried to figure it out myself, but: > > > > Do ndarray.<method>s which have an "equivalent" > numpy.<method> actually call the numpy method to > operate on self? > > Note that the latter are called functions, not methods. Sorry, of course, my bad. > Where there is > an equivalence, the function calls the method, not vice > versa. Take a > look at the source of numpy.std, for instance. Interesting; why? Because presently we're doing the doc the other way: if someone does help(ndarray.<method>) (and there's an equivalent numpy function) they're referred to the function for (detailed) help. :-) Granted, this "reversal" probably doesn't matter since which is calling which isn't typically seen by the user, but I just thought I'd note it in case anyone has a problem with it (and thus wants to discuss it further). DG > > -- > Robert Kern > > "I have come to believe that the whole world is an enigma, > a harmless > enigma that is made terrible by our own mad attempt to > interpret it as > though it had an underlying truth." > -- Umberto Eco > _______________________________________________ > Scipy-dev mailing list > Scipy-dev(a)scipy.org > http://mail.scipy.org/mailman/listinfo/scipy-dev >

2 1

Re: [SciPy-dev] Definition of class multiarray
by David Goldsmith June 26, 2009

June 26, 2009

OK, tried to figure it out myself, but: Do ndarray.<method>s which have an "equivalent" numpy.<method> actually call the numpy method to operate on self? DG --- On Fri, 6/26/09, Pauli Virtanen <pav(a)iki.fi> wrote: > From: Pauli Virtanen <pav(a)iki.fi> > Subject: Re: [SciPy-dev] Definition of class multiarray > To: scipy-dev(a)scipy.org > Date: Friday, June 26, 2009, 11:13 AM > On 2009-06-26, David Goldsmith <d_l_goldsmith(a)yahoo.com> > wrote: > > Hi. Where is class multiarray defined? > Thanks! > > There's no class named multiarray. numpy.core.multiarray is > an > extension module written in C, providing eg. the ndarray > class. > > You can find the sources under numpy/core/src > > -- > Pauli Virtanen > > _______________________________________________ > Scipy-dev mailing list > Scipy-dev(a)scipy.org > http://mail.scipy.org/mailman/listinfo/scipy-dev >

2 1

Definition of class multiarray
by David Goldsmith June 26, 2009

June 26, 2009

Hi. Where is class multiarray defined? Thanks! DG

2 1

Documenting data attributes
by David Goldsmith June 25, 2009

June 25, 2009

Hi! For the purposes of meeting the documentation standard, are data attributes regarded has "returning" something, i.e., should ndarray.itemsize, for example, have a Returns section? DG

3 3

Re: [SciPy-dev] Documenting data attributes
by David Goldsmith June 25, 2009

June 25, 2009

Well, they're already being documented separately (see, e.g., http://docs.scipy.org/numpy/Milestones/#ndarray-ii-status-63-done-leader-yo…, under which several data attributes are listed as needing documentation, independent of the separate listing of numpy.ndarray under http://docs.scipy.org/numpy/Milestones/#ndarray-ii-status-63-done-leader-yo…). DG --- On Thu, 6/25/09, Robert Kern <robert.kern(a)gmail.com> wrote: > From: Robert Kern <robert.kern(a)gmail.com> > Subject: Re: [SciPy-dev] Documenting data attributes > To: "SciPy Developers List" <scipy-dev(a)scipy.org> > Date: Thursday, June 25, 2009, 1:55 PM > On Thu, Jun 25, 2009 at 15:49, David > Goldsmith<d_l_goldsmith(a)yahoo.com> > wrote: > > > > Hi! For the purposes of meeting the documentation > standard, are data attributes regarded has "returning" > something, i.e., should ndarray.itemsize, for example, have > a Returns section? > > I would describe them in an Attributes section of the > class's > docstring. See MachAr for an example I did some time ago. > > http://docs.scipy.org/numpy/docs/numpy.lib.machar.MachAr/ > > -- > Robert Kern > > "I have come to believe that the whole world is an enigma, > a harmless > enigma that is made terrible by our own mad attempt to > interpret it as > though it had an underlying truth." > -- Umberto Eco > _______________________________________________ > Scipy-dev mailing list > Scipy-dev(a)scipy.org > http://mail.scipy.org/mailman/listinfo/scipy-dev >

2 1

Re: [SciPy-dev] Summer Marathon: targeting a category per week
by David Goldsmith June 25, 2009

June 25, 2009

OK, we have a couple nominees already: polynomials, or "one of the masked array ones." I'm partial to polynomials myself; anyone else want to opine? DG --- On Thu, 6/25/09, David Goldsmith <d_l_goldsmith(a)yahoo.com> wrote: > From: David Goldsmith <d_l_goldsmith(a)yahoo.com> > Subject: [SciPy-dev] Summer Marathon: targeting a category per week > To: scipy-dev(a)scipy.org > Date: Thursday, June 25, 2009, 1:39 PM > > Hi, folks! So, one of the ideas that came out of last > week's Skypecon for increasing participation in the Marathon > is to pick a category each week to target for "completion" > (meaning Marathon goal met = getting every function to at > least the "needs first review" stage) by the following > week's Skypecon. No one nominated any categories last > week, but I'm not giving up that easily ;-). I hereby > call for suggestions for a target category for this week > (i.e., to be completed by next Wed. July 1) but if I don't > receive any by tomorrow morning my time (UTC-7), I'll just > choose. :-) Thanks! > > DG > > > > _______________________________________________ > Scipy-dev mailing list > Scipy-dev(a)scipy.org > http://mail.scipy.org/mailman/listinfo/scipy-dev >

1 0