Re: [Numpy-discussion] Willing to contribute to SciPy & NumPy ...

2011-03-31 Thread Benjamin Root
On Thu, Mar 31, 2011 at 3:29 PM, Christopher Barker
wrote:

> On 3/31/11 12:04 PM, Anthony Scopatz wrote:
>
> > (with which I am inclined to agree), documentation is probably not the
> > best way to get started.
>
> I agree as well. However, I think newbies can be a great help in
> identifying holes in the documentation -- so when documentation is
> missing or unclear, ask here, and then you'll have something to contribute.
>
>
+1 on this.  The biggest problem with developers writing documentation for
tools like NumPy is that we have already become accustom to the quirks and
assumptions of the tool.  Fresh minds are perfect for identifying problem
areas in the docs.

The problem I have seen, though, is that it becomes so easy to just answer
the user's question and then just move on.  We really need to better remind
ourselves that each time someone has to ask an "easy" question, it is a
failing with our documentation.

"What if it was already in the docs", you ask?  Then the question is, why
couldn't they find it (or recognize it)?

"What if they didn't read the documentation", you say?  Then the question
becomes how did our documentation fail to be read?

Just food for thought...

Ben Root
___
NumPy-Discussion mailing list
NumPy-Discussion@scipy.org
http://mail.scipy.org/mailman/listinfo/numpy-discussion


Re: [Numpy-discussion] Willing to contribute to SciPy & NumPy ...

2011-03-31 Thread Christopher Barker
On 3/31/11 12:04 PM, Anthony Scopatz wrote:
> A good place to get started is helping out with documentation (see
> http://docs.scipy.org/numpy/Front%20Page/).
>
>
> Actually, according to the Jacob Kaplan-Moss's talk at PyCon this year
> (http://pycon.blip.tv/file/4881071/)

Nice talk -- thanks for the link.

> (with which I am inclined to agree), documentation is probably not the
> best way to get started.

I agree as well. However, I think newbies can be a great help in 
identifying holes in the documentation -- so when documentation is 
missing or unclear, ask here, and then you'll have something to contribute.

-Chris

> Do check out the developer zone, maybe search the the open tickets and
> see if there are any bugs you want to tackle.
> Maybe write some tests for untested code you find.

Good ideas as well, of course.

-Chris



-- 
Christopher Barker, Ph.D.
Oceanographer

Emergency Response Division
NOAA/NOS/OR&R(206) 526-6959   voice
7600 Sand Point Way NE   (206) 526-6329   fax
Seattle, WA  98115   (206) 526-6317   main reception

chris.bar...@noaa.gov
___
NumPy-Discussion mailing list
NumPy-Discussion@scipy.org
http://mail.scipy.org/mailman/listinfo/numpy-discussion


Re: [Numpy-discussion] Willing to contribute to SciPy & NumPy ...

2011-03-31 Thread Anthony Scopatz
On Thu, Mar 31, 2011 at 3:04 AM, Scott Sinclair  wrote:

> On 31 March 2011 07:27, Sylvain Bellemare  wrote:
> >  I would like to seriously start contributing to NumPy and/or SciPy, as
> much as I possibly can.
>
> I'm sure that your help will be welcomed!
>
> A good place to get started is helping out with documentation (see
> http://docs.scipy.org/numpy/Front%20Page/).


Actually, according to the Jacob Kaplan-Moss's talk at PyCon this year (
http://pycon.blip.tv/file/4881071/)
(with which I am inclined to agree), documentation is probably not the best
way to get started.

Do check out the developer zone, maybe search the the open tickets and see
if there are any bugs you want to tackle.
Maybe write some tests for untested code you find.  If you have questions,
don't hesitate to ask.  And don't forget
to test and document your own code!

Be Well
Anthony


> SciPy has plenty of work
> required - you'll probably learn your way into the code that way.
> Another place to look is http://www.scipy.org/Developer_Zone. It's
> worthwhile learning how to work with Git and Github if you want to get
> patches accepted more easily.
>
> Cheers,
> Scott
> ___
> NumPy-Discussion mailing list
> NumPy-Discussion@scipy.org
> http://mail.scipy.org/mailman/listinfo/numpy-discussion
>
___
NumPy-Discussion mailing list
NumPy-Discussion@scipy.org
http://mail.scipy.org/mailman/listinfo/numpy-discussion


Re: [Numpy-discussion] Willing to contribute to SciPy & NumPy ...

2011-03-31 Thread Scott Sinclair
On 31 March 2011 07:27, Sylvain Bellemare  wrote:
>  I would like to seriously start contributing to NumPy and/or SciPy, as much 
> as I possibly can.

I'm sure that your help will be welcomed!

A good place to get started is helping out with documentation (see
http://docs.scipy.org/numpy/Front%20Page/). SciPy has plenty of work
required - you'll probably learn your way into the code that way.
Another place to look is http://www.scipy.org/Developer_Zone. It's
worthwhile learning how to work with Git and Github if you want to get
patches accepted more easily.

Cheers,
Scott
___
NumPy-Discussion mailing list
NumPy-Discussion@scipy.org
http://mail.scipy.org/mailman/listinfo/numpy-discussion