That is a great article, Nathan.  I agree with nearly all of the points made there, and I think it's a worthwhile read for everyone (particularly the people participating in the docs sprint).  Thanks for sharing!

Cameron


On Tue, Sep 3, 2013 at 11:27 AM, Nathan Goldbaum <nathan12343@gmail.com> wrote:
Hi all,

This came up on my news feed today: http://stevelosh.com/blog/2013/09/teach-dont-tell/

I think there's a lot to be gleaned from it that could help improve yt's documentation.

-Nathan


On Sun, Sep 1, 2013 at 6:52 AM, Britton Smith <brittonsmith@gmail.com> wrote:
Depending on what time you guys do this, I could probably pitch in remotely.


On Wed, Aug 28, 2013 at 9:00 PM, Cameron Hummels <chummels@gmail.com> wrote:
Oh good.  I'll potentially be in NYC around that time, so I can sprint in person.  Thanks for getting these dates set up, Matt.


On Wed, Aug 28, 2013 at 11:43 AM, Matthew Turk <matthewturk@gmail.com> wrote:
Hello again,

I misread Jeff's email.  John can only do the first two, Jeff can only
do the latter two.  So that leaves the middle set is the only one we
can do.  So let's do the same thing, but October 28 and 29.

-Matt



On Wed, Aug 28, 2013 at 2:39 PM, Matthew Turk <matthewturk@gmail.com> wrote:
> Alright, seeing as how there's a push for the first couple, why don't
> we plan on a mini-sprint on the 7th and 8th of October?  Those able to
> come up to Columbia are welcome, as I mentioned before, and those who
> can't, we'll be hanging out in IRC or Hangouts as well.
>
> -Matt
>
> On Wed, Aug 28, 2013 at 2:34 PM, Cameron Hummels <chummels@gmail.com> wrote:
>> Any and all work for me.
>>
>>
>> On Wed, Aug 28, 2013 at 10:28 AM, Sam Skillman <samskillman@gmail.com>
>> wrote:
>>>
>>> I'd prefer one of the first two options as well.
>>>
>>> Sam
>>>
>>>
>>> On Wed, Aug 28, 2013 at 8:26 AM, John ZuHone <jzuhone@gmail.com> wrote:
>>>>
>>>> I'd prefer the first two sets of dates.
>>>>
>>>> John Z
>>>>
>>>> Sent from John ZuHone's iPad
>>>>
>>>> On Aug 28, 2013, at 11:05 AM, Matthew Turk <matthewturk@gmail.com> wrote:
>>>>
>>>> > Hi all,
>>>> >
>>>> > Just as a followup, I wanted to put out a few possible days for a
>>>> > sprint.  I'd be available these days:
>>>> >
>>>> > Oct 7-10
>>>> > Oct 28-Nov 1
>>>> > Nov 4-8
>>>> >
>>>> > Do any of those sound like good candidates?
>>>> >
>>>> > -Matt
>>>> >
>>>> > On Sat, Aug 17, 2013 at 1:28 PM, John ZuHone <jzuhone@gmail.com> wrote:
>>>> >> I'm possibly game for a Columbia sprint as well.
>>>> >>
>>>> >> John ZuHone
>>>> >> Laboratory for High-Energy Astrophysics
>>>> >> NASA/Goddard Space Flight Center
>>>> >> 8800 Greenbelt Rd., Code 662
>>>> >> Greenbelt, MD 20771
>>>> >> (w) 301-286-2531
>>>> >> (m) 773-758-0172
>>>> >> jzuhone@gmail.com
>>>> >> john.zuhone@nasa.gov
>>>> >>
>>>> >> On Aug 17, 2013, at 11:17 AM, j s oishi <jsoishi@gmail.com> wrote:
>>>> >>
>>>> >> I'd be in for that as well: an NYC documentation sprint.
>>>> >>
>>>> >>
>>>> >> On Sat, Aug 17, 2013 at 11:16 AM, Cameron Hummels <chummels@gmail.com>
>>>> >> wrote:
>>>> >>>
>>>> >>> That sounds great to me!  I'll happily be the doc steward.  I like
>>>> >>> the
>>>> >>> idea of small local sprints.  It's too bad I didn't go to the AGORA
>>>> >>> thing
>>>> >>> this weekend, as we could do one there.  Oh well.  But yes,
>>>> >>> October/November
>>>> >>> sounds like a great time to do this.  Perhaps we can do one the next
>>>> >>> time I
>>>> >>> come to NYC too.
>>>> >>>
>>>> >>> Cameron
>>>> >>>
>>>> >>>
>>>> >>> On Sat, Aug 17, 2013 at 5:46 AM, Matthew Turk <matthewturk@gmail.com>
>>>> >>> wrote:
>>>> >>>>
>>>> >>>> Hi Cameron et al,
>>>> >>>>
>>>> >>>> This is a very good idea.  Cameron, I think you would be well-suited
>>>> >>>> to being a documentation steward for yt -- not in terms of *writing*
>>>> >>>> it, but helping to ensure that the coverage remains high and that
>>>> >>>> features aren't simply forgotten about as they are submitted.
>>>> >>>>
>>>> >>>> As for a sprint, I would be very keen to have one, and at the time
>>>> >>>> when development switches over would be a perfect one.  Since
>>>> >>>> there's
>>>> >>>> some clustering of yt devs recently, what we could try for is
>>>> >>>> semi-remote sprints.  Anybody that wanted to come to Columbia, I'd
>>>> >>>> buy
>>>> >>>> pizza for and we could all write in the same room.  Interested
>>>> >>>> participants that are clustered at other institutions could work
>>>> >>>> together, too, and the groups could meet over IRC/Hangouts.
>>>> >>>>
>>>> >>>> But yes, let's aim for this.  Perhaps sometime in October or
>>>> >>>> November?
>>>> >>>> Or is that too soon?
>>>> >>>>
>>>> >>>> -Matt
>>>> >>>>
>>>> >>>> On Fri, Aug 16, 2013 at 6:23 PM, Cameron Hummels
>>>> >>>> <chummels@gmail.com>
>>>> >>>> wrote:
>>>> >>>>> Hey peeps,
>>>> >>>>>
>>>> >>>>> After talking with Matt at some length about the yt documentation,
>>>> >>>>> we
>>>> >>>>> thought it might be a good idea to have a documentation sprint in a
>>>> >>>>> few
>>>> >>>>> months when we've moved over to yt 3.0 as the focus of our
>>>> >>>>> development.
>>>> >>>>> The
>>>> >>>>> docs in general are good, but there are some gaps here and there
>>>> >>>>> with
>>>> >>>>> some
>>>> >>>>> functionality not present in the documentation.  I'm not proposing
>>>> >>>>> an
>>>> >>>>> entire
>>>> >>>>> (or even partial) rewrite of the docs, as I think that would be
>>>> >>>>> counterproductive.  I'm simply thinking we could fill in the holes
>>>> >>>>> to
>>>> >>>>> make
>>>> >>>>> sure all of the cool stuff in yt is written up so people know how
>>>> >>>>> to
>>>> >>>>> use it.
>>>> >>>>>
>>>> >>>>> Now, I know doc writing is not often fun, but I think this could be
>>>> >>>>> really
>>>> >>>>> beneficial to our user base, and actually cut down on the amount of
>>>> >>>>> time we
>>>> >>>>> have to respond to new users on the mailing list and irc (as well
>>>> >>>>> as
>>>> >>>>> making
>>>> >>>>> it easier for people to use yt).
>>>> >>>>>
>>>> >>>>> What I'm asking from you is if you encounter something that you
>>>> >>>>> don't
>>>> >>>>> think
>>>> >>>>> is well documented in the formal docs (not simply the docstrings),
>>>> >>>>> could you
>>>> >>>>> take a moment to create a bitbucket issue about it?  You don't even
>>>> >>>>> have to
>>>> >>>>> fix it then, just note it, so we know where to work when we do the
>>>> >>>>> sprint in
>>>> >>>>> a few months.
>>>> >>>>>
>>>> >>>>> Anyone else have any other ideas about this?
>>>> >>>>>
>>>> >>>>> Cameron
>>>> >>>>>
>>>> >>>>> --
>>>> >>>>> Cameron Hummels
>>>> >>>>> Postdoctoral Researcher
>>>> >>>>> Steward Observatory
>>>> >>>>> University of Arizona
>>>> >>>>> http://chummels.org
>>>> >>>>>
>>>> >>>>> _______________________________________________
>>>> >>>>> yt-dev mailing list
>>>> >>>>> yt-dev@lists.spacepope.org
>>>> >>>>> http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org
>>>> >>>> _______________________________________________
>>>> >>>> yt-dev mailing list
>>>> >>>> yt-dev@lists.spacepope.org
>>>> >>>> http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org
>>>> >>>
>>>> >>>
>>>> >>>
>>>> >>>
>>>> >>> --
>>>> >>> Cameron Hummels
>>>> >>> Postdoctoral Researcher
>>>> >>> Steward Observatory
>>>> >>> University of Arizona
>>>> >>> http://chummels.org
>>>> >>>
>>>> >>> _______________________________________________
>>>> >>> yt-dev mailing list
>>>> >>> yt-dev@lists.spacepope.org
>>>> >>> http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org
>>>> >>
>>>> >> _______________________________________________
>>>> >> yt-dev mailing list
>>>> >> yt-dev@lists.spacepope.org
>>>> >> http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org
>>>> >>
>>>> >>
>>>> >> _______________________________________________
>>>> >> yt-dev mailing list
>>>> >> yt-dev@lists.spacepope.org
>>>> >> http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org
>>>> > _______________________________________________
>>>> > yt-dev mailing list
>>>> > yt-dev@lists.spacepope.org
>>>> > http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org
>>>> _______________________________________________
>>>> yt-dev mailing list
>>>> yt-dev@lists.spacepope.org
>>>> http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org
>>>
>>>
>>>
>>> _______________________________________________
>>> yt-dev mailing list
>>> yt-dev@lists.spacepope.org
>>> http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org
>>>
>>
>>
>>
>> --
>> Cameron Hummels
>> Postdoctoral Researcher
>> Steward Observatory
>> University of Arizona
>> http://chummels.org
>>
>> _______________________________________________
>> yt-dev mailing list
>> yt-dev@lists.spacepope.org
>> http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org
>>
_______________________________________________
yt-dev mailing list
yt-dev@lists.spacepope.org
http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org



--
Cameron Hummels
Postdoctoral Researcher
Steward Observatory
University of Arizona

_______________________________________________
yt-dev mailing list
yt-dev@lists.spacepope.org
http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org



_______________________________________________
yt-dev mailing list
yt-dev@lists.spacepope.org
http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org



_______________________________________________
yt-dev mailing list
yt-dev@lists.spacepope.org
http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org




--
Cameron Hummels
Postdoctoral Researcher
Steward Observatory
University of Arizona
http://chummels.org