[SciPy-User] [Announcement] The 2010 Summer Documentation Marathon is on!

David Goldsmith d.l.goldsmith at gmail.com
Mon May 24 00:37:18 EDT 2010


Hi, folks.  It's SciPy Marathon time again!

For those who have just joined us: the past two summers,
volunteers<%3Chttp://docs.scipy.org/numpy/contributors/%3E>from the
NumPy/SciPy community have worked together to improve NumPy's
documentation.  So far, we have written most of the docs for NumPy (see,
e.g., http://conference.scipy.org/proceedings/SciPy2009/paper_14/), using a
Wiki application (pydocweb <%3Chttp://code.google.com/p/pydocweb/>, thanks
to Pauli-Virtanen, Emmanuelle Gouillart, Stéfan van der Walt, and Gael
Varoquaux) that we use to edit and manage the
docs<%3Chttp://docs.scipy.org/numpy/docs/%3E>
.  We have advanced the NumPy docstrings from only 8% being Ready For Review
or better, to 85% being so (click here
<http://docs.scipy.org/numpy/stats/>for details).

This summer, we will focus on doing the same thing for SciPy.  To
participate (and we very much hope you will), please start by reading
http://docs.scipy.org/numpy/Front%20Page/, and, in particular, the Before
You Start section (but it's all important).  (Despite the URL and any
wording that may make it seem otherwise, the information there is as
applicable to editing the SciPy documentation as it is to NumPy.)

As far as actually performing the work is concerned, we will again attack
these things as teams: go to http://docs.scipy.org/scipy/Milestones/ and
poke around.  Figure out where you think you could do the most good, and
join that team by appending your name below the Milestone(s).  If you think
you could help lead a team (i.e., answer technical questions about the
subject(s) encompassed by a Milestone) and are willing to do so, please
append (L) to your name.

As the summer progresses, look for Marathon-related announcements on the
scipy-dev email list (subscription strongly recommended for Marathon
participants).  Happy editing!

David Goldsmith
Editor Pro Tem
-- 
Mathematician: noun, someone who disavows certainty when their uncertainty
set is non-empty, even if that set has measure zero.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.scipy.org/pipermail/scipy-user/attachments/20100523/7bb9a7f3/attachment.html>


More information about the SciPy-User mailing list