Stéfan van der Walt wrote:
> It looks like there is significant interest in using "np" instead of
> "numpy" in the examples (i.e. we expect the user to do "import numpy
> as np" before trying code snippets).
>
> Would anybody who objects to using "np" raise it now, so that we can
> bury this issue?
It looks like there is significant interest in using "np" instead of
"numpy" in the examples (i.e. we expect the user to do "import numpy
as np" before trying code snippets).
Would anybody who objects to using "np" raise it now, so that we can
bury this issue?
Regards
Stéfan
2008/5/22 Rob Hetlan
On May 22, 2008, at 11:37 AM, Pauli Virtanen wrote:
> Or should we "assume from numpy import *" or "import numpy as np"? I
Although a good case could probably be made for all three (*, np,
numpy), I think that if "import numpy as np" is to be put forward as
the standard coding style, the ex
ke, 2008-05-21 kello 10:08 +0200, Stéfan van der Walt kirjoitti:
[clip]
> > This will parse better (as the line with the semicolon is bold, the
> > next lines are not). Also, would it be possible to put function and
> > next_function in double back-ticks, so that they are referenced, like
> > modu
Hi LB
2008/5/21 LB <[EMAIL PROTECTED]>:
> This is really a great news, and it seems very promising according to
> the first pages of the Wiki that I've seen.
>
> It's perhaps not the right place to say this, but I was wondering what
> you would thinking about adding labels or category to the descr
2008/5/21 LB <[EMAIL PROTECTED]>:
> This is really a great news, and it seems very promising according to
> the first pages of the Wiki that I've seen.
>
> It's perhaps not the right place to say this, but I was wondering what
> you would thinking about adding labels or category to the descriptions
This is really a great news, and it seems very promising according to
the first pages of the Wiki that I've seen.
It's perhaps not the right place to say this, but I was wondering what
you would thinking about adding labels or category to the descriptions
of each function ? I think It would really
On Wed, May 21, 2008 at 3:26 AM, Rob Hetland <[EMAIL PROTECTED]> wrote:
>
> On May 21, 2008, at 9:40 AM, Robert Kern wrote:
>
>> But please, let's not rehash discussions which have already happened
>> (like this one).
>
> I didn't mean to suggest rehashing the documentation format. I agree
> that
Stéfan van der Walt wrote:
> Hi Bruce
>
> 2008/5/21 Bruce Southey <[EMAIL PROTECTED]>:
>
>> I would like to throw out the following idea with no obligations:
>> IF people have the time and energy while writing the documentation, can
>> they also test that the function is doing what it is expecte
Hi Bruce
2008/5/21 Bruce Southey <[EMAIL PROTECTED]>:
> I would like to throw out the following idea with no obligations:
> IF people have the time and energy while writing the documentation, can
> they also test that the function is doing what it is expected?
> Also related to this is developing
Hi,
I would like to throw out the following idea with no obligations:
IF people have the time and energy while writing the documentation, can
they also test that the function is doing what it is expected?
Also related to this is developing appropriate tests if these are not
covered or at least pr
On May 21, 2008, at 9:40 AM, Robert Kern wrote:
> But please, let's not rehash discussions which have already happened
> (like this one).
I didn't mean to suggest rehashing the documentation format. I agree
that this has been discussed enough.
Rather, sometimes it's not clear to me how to ap
Hi Rob
2008/5/21 Rob Hetland <[EMAIL PROTECTED]>:
> See Also
>
> function : One line description from function's docstring
> Longer description here over potentially many lines. Lorem ipsum
> dolor sit amet,
> consectetur adipisicing elit, sed do eiusmod tempor incididunt ut
> lab
On Wed, May 21, 2008 at 2:27 AM, Rob Hetland <[EMAIL PROTECTED]> wrote:
>
> Should we add a general discussion section to the Wiki?
Discussion should happen here on the mailing list instead of the wiki.
But please, let's not rehash discussions which have already happened
(like this one). They simp
Should we add a general discussion section to the Wiki? I would just
do this, but it seems like a fundamental enough addition that I though
I would suggest it first. The rational is that there are some
stylistic questions that are not covered in the example. For
instance, I think that t
On Wed, May 21, 2008 at 1:27 AM, Pauli Virtanen <[EMAIL PROTECTED]> wrote:
> I think it would be quite straightforward to write a function that
> crawled over the numpy namespace and dynamically replaced __doc__ with
> gettextized versions. The user could call this function to switch the
> languag
ti, 2008-05-20 kello 18:04 -0500, Robert Kern kirjoitti:
> On Tue, May 20, 2008 at 5:55 PM, Jonathan Wright <[EMAIL PROTECTED]> wrote:
> > Stéfan van der Walt wrote:
> > > As for internationali(s/z)ation, we'll see who writes the most
> > > docstrings.
> >
> > Indeed. There are some notes on the
On Tue, May 20, 2008 at 5:55 PM, Jonathan Wright <[EMAIL PROTECTED]> wrote:
> Stéfan van der Walt wrote:
> > As for internationali(s/z)ation, we'll see who writes the most
> > docstrings.
>
> Indeed. There are some notes on the OLPC wiki at
>
> http://wiki.laptop.org/go/Python_i18n
>
> It seems t
Stéfan van der Walt wrote:
> As for internationali(s/z)ation, we'll see who writes the most
> docstrings.
Indeed. There are some notes on the OLPC wiki at
http://wiki.laptop.org/go/Python_i18n
It seems to be just a question of adding at the top of add_newdocs.py
from gettext import gettext as
2008/5/20 Jonathan Wright <[EMAIL PROTECTED]>:
> Joe Harrington wrote:
>> NUMPY/SCIPY DOCUMENTATION MARATHON 2008
>>
> On the wiki it says: "Writers should be fluent in English"
>
> In case someone is working on the dynamic docstring magic, is this a
> good moment to mention "international
ti, 2008-05-20 kello 20:06 +0200, Rob Hetland kirjoitti:
> On May 20, 2008, at 7:30 PM, Stéfan van der Walt wrote:
>
> > and send us your UserName.
>
>
> Oh, and my username is RobHetland
You're in now.
Regards,
Pauli
___
Numpy-discussion mailing
On May 20, 2008, at 7:30 PM, Stéfan van der Walt wrote:
> and send us your UserName.
Oh, and my username is RobHetland
-Rob
Rob Hetland, Associate Professor
Dept. of Oceanography, Texas A&M University
http://pong.tamu.edu/~rob
phone: 979-458-0096, fax: 979-845-6331
__
On May 20, 2008, at 7:30 PM, Stéfan van der Walt wrote:
> ...and send us your UserName.
This is the part I skipped over... I registered, and wondered why
everything was not editable.
-Rob
Rob Hetland, Associate Professor
Dept. of Oceanography, Texas A&M University
http://pong.tamu.edu
Joe Harrington wrote:
> NUMPY/SCIPY DOCUMENTATION MARATHON 2008
>
On the wiki it says: "Writers should be fluent in English"
In case someone is working on the dynamic docstring magic, is this a
good moment to mention "internationalisation" and "world domination" in
the same sentence?
Hi Rob
Which of the instructions are not clear? We'd like to make this as
accessible as possible.
In order to start editing, you need to complete step 5, which is to
register on the wiki and send us your UserName.
Regards
Stéfan
2008/5/20 Rob Hetland <[EMAIL PROTECTED]>:
>
> I would like to he
I would like to help, but it's not clear to me exactly how to do that
from the wiki. What are the steps?
-Rob
___
Numpy-discussion mailing list
Numpy-discussion@scipy.org
http://projects.scipy.org/mailman/listinfo/numpy-discussion
Hi Alan
Yes, the one discussed in this thread:
http://groups.google.com/group/sphinx-dev/browse_thread/thread/ef74352b9f196002/0e257bc8c116f73f
I've only had to make one change so far, to parse '*' as in 'A^*'
(patch attached). Unfortunately, the author chose incomprehensible
variable names lik
On Tue, 20 May 2008, Stéfan van der Walt apparently wrote:
> Also, the math role and directive, i.e.
> :math:`\int_0^\infty` and
> .. math:: \int_0^\infty
> now render correctly.
Is this being done with Jens's writers?
If not, I'd like to know how.
Thank you,
Alan Isaac
PS There is currently
2008/5/20 Steven H. Rogers <[EMAIL PROTECTED]>:
>> .. [1] http://mentat.za.net/numpy/refguide/
>>So far, this preview contains only docs for ndarray, though.
The reference guide has been updated to contain the entire numpy.
Once we've applied indexing tags to functions, those will be sorted in
Pauli Virtanen wrote:
> Hi,
>
> su, 2008-05-18 kello 07:16 -0600, Steven H. Rogers kirjoitti:
>
>> Joe Harrington wrote:
>>
>>>NUMPY/SCIPY DOCUMENTATION MARATHON 2008
>>> ...
>>> 5. Write a new help function that optionally produces ASCII or points
>>> the user's PDF or HTML reader
Hi,
su, 2008-05-18 kello 07:16 -0600, Steven H. Rogers kirjoitti:
> Joe Harrington wrote:
> >NUMPY/SCIPY DOCUMENTATION MARATHON 2008
> > ...
> > 5. Write a new help function that optionally produces ASCII or points
> > the user's PDF or HTML reader to the right page (either local or
> > gl
Joe Harrington wrote:
> NUMPY/SCIPY DOCUMENTATION MARATHON 2008
> ...
> 5. Write a new help function that optionally produces ASCII or points
> the user's PDF or HTML reader to the right page (either local or
> global).
>
I can work on this. Fernando suggested this at the IPython sprin
> I didn't see Travis's Numpy book mentioned at all in your writeup, so
> I am wondering where its role in the doc effort is.
> Is it OK to copy material out of the book and into
> other parts of the documentation?
No worries, Travis is on board here. We included him and others on
the Steering
Hi Andreas
2008/5/17 Andreas Klöckner <[EMAIL PROTECTED]>:
> On Samstag 17 Mai 2008, Joe Harrington wrote:
>> To head off another pedagogical meltdown, the University of Central
>> Florida has hired Stefan van der Walt full time to coordinate a
>> community documentation effort to write reference
On Samstag 17 Mai 2008, Joe Harrington wrote:
> To head off another pedagogical meltdown, the University of Central
> Florida has hired Stefan van der Walt full time to coordinate a
> community documentation effort to write reference documentation and
> tools.
This is truly excellent news. One qu
NUMPY/SCIPY DOCUMENTATION MARATHON 2008
As we all know, the state of the numpy and scipy reference
documentation (aka the docstrings) is best described as "incomplete".
Most functions have docstrings shorter than 5 lines, whereas our
competitors IDL and Matlab usually have a concise and
36 matches
Mail list logo
