Ralf Gommers
2017-03-07 21:01:15 UTC
Hi all,
The docathlon has started, and Warren got us off the mark with
https://github.com/scipy/scipy/pull/7138 (thanks!).
If you want to contribute, an easy way is what Warren did: pick a function
with an incomplete docstring (e.g. missing example) and add it.
Alternatively, look at one of the issues with the documentation label:
https://github.com/scipy/scipy/issues?q=is%3Aopen+is%3Aissue+label%3ADocumentation
And remember to start your commit message with DOC:.
Cheers,
Ralf
---------- Forwarded message ----------
From: The Docathon Team <***@berkeley.edu>
Date: Tue, Mar 7, 2017 at 3:58 PM
Subject: Docathon Day 1 Update: The Doccening
To: ***@gmail.com
*To err is human, to document is divine -Docrates*
The Docathon is One Day Old!
<http://predictablynoisy.us15.list-manage.com/track/click?u=80bb9d960ec9c9896a0cf4b96&id=0ec2fea0ee&e=2abb39d3c3>
The docathon just turned one (day old)! Here's a quick update to
congratulate everybody on a great first day.
Updates
- We kicked off the week at BIDS by hosting a half-day of Documentation
Tutorials
<http://predictablynoisy.us15.list-manage.com/track/click?u=80bb9d960ec9c9896a0cf4b96&id=1afea71949&e=2abb39d3c3>.
These were live-streamed on youtube
<http://predictablynoisy.us15.list-manage.com/track/click?u=80bb9d960ec9c9896a0cf4b96&id=e71eead367&e=2abb39d3c3>
for
your viewing pleasure!
- We also demoed a template repository
<http://predictablynoisy.us15.list-manage.com/track/click?u=80bb9d960ec9c9896a0cf4b96&id=1c72bfc58a&e=2abb39d3c3>
to
help you get sphinx / numpydoc / sphinx-gallery working with your project.
Use that along with this guide repository
<http://predictablynoisy.us15.list-manage1.com/track/click?u=80bb9d960ec9c9896a0cf4b96&id=9445cbbfde&e=2abb39d3c3>
to
help you get started!
Check out the docboards!
My favorite thing about today is that you can totally see a bump in the
documentation commits for our projects. You can check that out on our
global activity board below:
*Global Activity*
We should also give a shout out to our docstar projects that showed a big
bump in activity today. Here's our docboard for project commits:
Three cheers for:
- PMagPy
<http://predictablynoisy.us15.list-manage1.com/track/click?u=80bb9d960ec9c9896a0cf4b96&id=8aff4877b1&e=2abb39d3c3>,
a python project for analyzing paleomagnetic data
- cottoncandy
<http://predictablynoisy.us15.list-manage.com/track/click?u=80bb9d960ec9c9896a0cf4b96&id=e5dd008166&e=2abb39d3c3>,
a project for storing and flexibly accessing numpy data on Amazon S3.
- Sylius
<http://predictablynoisy.us15.list-manage.com/track/click?u=80bb9d960ec9c9896a0cf4b96&id=78ddd17b90&e=2abb39d3c3>,
a platform for e-commerce using PHP
We also got a big bump in commits from individual users! Here's what
everybody has been up to:
Let's give a shout out to this day's docstars *anwarnunez*, *willingc*, and
*swanson-hysell*.
Keep it going!
We look forward to seeing what comes next tomorrow. The working groups will
be holding sessions once again, though we've gotten a lot of great
contributions from people all over the country! We're making great
progress, so let's keep the momentum through tomorrow!
Until then,
*The Docathon Team*
Docathon website
<http://predictablynoisy.us15.list-manage1.com/track/click?u=80bb9d960ec9c9896a0cf4b96&id=2a57e9a1cf&e=2abb39d3c3>
Projects page
<http://predictablynoisy.us15.list-manage.com/track/click?u=80bb9d960ec9c9896a0cf4b96&id=6c79c0c1a2&e=2abb39d3c3>
Hosts page
<http://predictablynoisy.us15.list-manage2.com/track/click?u=80bb9d960ec9c9896a0cf4b96&id=1205a5acce&e=2abb39d3c3>
Slack channel
<http://predictablynoisy.us15.list-manage2.com/track/click?u=80bb9d960ec9c9896a0cf4b96&id=0657a0d8ba&e=2abb39d3c3>
Github repo
<http://predictablynoisy.us15.list-manage.com/track/click?u=80bb9d960ec9c9896a0cf4b96&id=9cb9f8e687&e=2abb39d3c3>
all hail the party parrot
[image: Email Marketing Powered by MailChimp]
<http://www.mailchimp.com/monkey-rewards/?utm_source=freemium_newsletter&utm_medium=email&utm_campaign=monkey_rewards&aid=80bb9d960ec9c9896a0cf4b96&afl=1>
<http://predictablynoisy.us15.list-manage1.com/track/click?u=80bb9d960ec9c9896a0cf4b96&id=c426216e02&e=2abb39d3c3>
<http://bids.github.io/docathon>
<http://predictablynoisy.us15.list-manage.com/track/click?u=80bb9d960ec9c9896a0cf4b96&id=61d7c75b33&e=2abb39d3c3>
All hail the party parrot.
<http://predictablynoisy.us15.list-manage1.com/track/click?u=80bb9d960ec9c9896a0cf4b96&id=49ace0b911&e=2abb39d3c3>
Want to change how you receive these emails?
You can update your preferences
<http://predictablynoisy.us15.list-manage.com/profile?u=80bb9d960ec9c9896a0cf4b96&id=79530de0f5&e=2abb39d3c3>
or unsubscribe from this list
<http://predictablynoisy.us15.list-manage.com/unsubscribe?u=80bb9d960ec9c9896a0cf4b96&id=79530de0f5&e=2abb39d3c3&c=cfdc895f86>
The docathlon has started, and Warren got us off the mark with
https://github.com/scipy/scipy/pull/7138 (thanks!).
If you want to contribute, an easy way is what Warren did: pick a function
with an incomplete docstring (e.g. missing example) and add it.
Alternatively, look at one of the issues with the documentation label:
https://github.com/scipy/scipy/issues?q=is%3Aopen+is%3Aissue+label%3ADocumentation
And remember to start your commit message with DOC:.
Cheers,
Ralf
---------- Forwarded message ----------
From: The Docathon Team <***@berkeley.edu>
Date: Tue, Mar 7, 2017 at 3:58 PM
Subject: Docathon Day 1 Update: The Doccening
To: ***@gmail.com
*To err is human, to document is divine -Docrates*
The Docathon is One Day Old!
<http://predictablynoisy.us15.list-manage.com/track/click?u=80bb9d960ec9c9896a0cf4b96&id=0ec2fea0ee&e=2abb39d3c3>
The docathon just turned one (day old)! Here's a quick update to
congratulate everybody on a great first day.
Updates
- We kicked off the week at BIDS by hosting a half-day of Documentation
Tutorials
<http://predictablynoisy.us15.list-manage.com/track/click?u=80bb9d960ec9c9896a0cf4b96&id=1afea71949&e=2abb39d3c3>.
These were live-streamed on youtube
<http://predictablynoisy.us15.list-manage.com/track/click?u=80bb9d960ec9c9896a0cf4b96&id=e71eead367&e=2abb39d3c3>
for
your viewing pleasure!
- We also demoed a template repository
<http://predictablynoisy.us15.list-manage.com/track/click?u=80bb9d960ec9c9896a0cf4b96&id=1c72bfc58a&e=2abb39d3c3>
to
help you get sphinx / numpydoc / sphinx-gallery working with your project.
Use that along with this guide repository
<http://predictablynoisy.us15.list-manage1.com/track/click?u=80bb9d960ec9c9896a0cf4b96&id=9445cbbfde&e=2abb39d3c3>
to
help you get started!
Check out the docboards!
My favorite thing about today is that you can totally see a bump in the
documentation commits for our projects. You can check that out on our
global activity board below:
*Global Activity*
We should also give a shout out to our docstar projects that showed a big
bump in activity today. Here's our docboard for project commits:
Three cheers for:
- PMagPy
<http://predictablynoisy.us15.list-manage1.com/track/click?u=80bb9d960ec9c9896a0cf4b96&id=8aff4877b1&e=2abb39d3c3>,
a python project for analyzing paleomagnetic data
- cottoncandy
<http://predictablynoisy.us15.list-manage.com/track/click?u=80bb9d960ec9c9896a0cf4b96&id=e5dd008166&e=2abb39d3c3>,
a project for storing and flexibly accessing numpy data on Amazon S3.
- Sylius
<http://predictablynoisy.us15.list-manage.com/track/click?u=80bb9d960ec9c9896a0cf4b96&id=78ddd17b90&e=2abb39d3c3>,
a platform for e-commerce using PHP
We also got a big bump in commits from individual users! Here's what
everybody has been up to:
Let's give a shout out to this day's docstars *anwarnunez*, *willingc*, and
*swanson-hysell*.
Keep it going!
We look forward to seeing what comes next tomorrow. The working groups will
be holding sessions once again, though we've gotten a lot of great
contributions from people all over the country! We're making great
progress, so let's keep the momentum through tomorrow!
Until then,
*The Docathon Team*
Docathon website
<http://predictablynoisy.us15.list-manage1.com/track/click?u=80bb9d960ec9c9896a0cf4b96&id=2a57e9a1cf&e=2abb39d3c3>
Projects page
<http://predictablynoisy.us15.list-manage.com/track/click?u=80bb9d960ec9c9896a0cf4b96&id=6c79c0c1a2&e=2abb39d3c3>
Hosts page
<http://predictablynoisy.us15.list-manage2.com/track/click?u=80bb9d960ec9c9896a0cf4b96&id=1205a5acce&e=2abb39d3c3>
Slack channel
<http://predictablynoisy.us15.list-manage2.com/track/click?u=80bb9d960ec9c9896a0cf4b96&id=0657a0d8ba&e=2abb39d3c3>
Github repo
<http://predictablynoisy.us15.list-manage.com/track/click?u=80bb9d960ec9c9896a0cf4b96&id=9cb9f8e687&e=2abb39d3c3>
all hail the party parrot
[image: Email Marketing Powered by MailChimp]
<http://www.mailchimp.com/monkey-rewards/?utm_source=freemium_newsletter&utm_medium=email&utm_campaign=monkey_rewards&aid=80bb9d960ec9c9896a0cf4b96&afl=1>
<http://predictablynoisy.us15.list-manage1.com/track/click?u=80bb9d960ec9c9896a0cf4b96&id=c426216e02&e=2abb39d3c3>
<http://bids.github.io/docathon>
<http://predictablynoisy.us15.list-manage.com/track/click?u=80bb9d960ec9c9896a0cf4b96&id=61d7c75b33&e=2abb39d3c3>
All hail the party parrot.
<http://predictablynoisy.us15.list-manage1.com/track/click?u=80bb9d960ec9c9896a0cf4b96&id=49ace0b911&e=2abb39d3c3>
Want to change how you receive these emails?
You can update your preferences
<http://predictablynoisy.us15.list-manage.com/profile?u=80bb9d960ec9c9896a0cf4b96&id=79530de0f5&e=2abb39d3c3>
or unsubscribe from this list
<http://predictablynoisy.us15.list-manage.com/unsubscribe?u=80bb9d960ec9c9896a0cf4b96&id=79530de0f5&e=2abb39d3c3&c=cfdc895f86>