<div dir="ltr">Yeah, that sounds like a good idea!</div><div class="gmail_extra"><br><br><div class="gmail_quote">On Sat, Aug 17, 2013 at 4:05 AM, Kacper Kowalik <span dir="ltr"><<a href="mailto:xarthisius.kk@gmail.com" target="_blank">xarthisius.kk@gmail.com</a>></span> wrote:<br>

<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div class="im">On 08/17/2013 12:23 AM, Cameron Hummels wrote:<br>
> Hey peeps,<br>
><br>
> After talking with Matt at some length about the yt documentation, we<br>
> thought it might be a good idea to have a documentation sprint in a few<br>
> months when we've moved over to yt 3.0 as the focus of our development.<br>
>  The docs in general are good, but there are some gaps here and there with<br>
> some functionality not present in the documentation.  I'm not proposing an<br>
> entire (or even partial) rewrite of the docs, as I think that would be<br>
> counterproductive.  I'm simply thinking we could fill in the holes to make<br>
> sure all of the cool stuff in yt is written up so people know how to use it.<br>
><br>
> Now, I know doc writing is not often fun, but I think this could be really<br>
> beneficial to our user base, and actually cut down on the amount of time we<br>
> have to respond to new users on the mailing list and irc (as well as making<br>
> it easier for people to use yt).<br>
><br>
> What I'm asking from you is if you encounter something that you don't think<br>
> is well documented in the formal docs (not simply the docstrings), could<br>
> you take a moment to create a bitbucket issue about it?  You don't even<br>
> have to fix it then, just note it, so we know where to work when we do the<br>
> sprint in a few months.<br>
<br>
</div>Can we make all docstrings self-consistent while we're touching<br>
documentation throughout the whole project? I know that involves code<br>
duplication in many cases but from my POV it has two advantages: being<br>
copy'n'pasteable and it would greatly increase the code coverage in tests.<br>
<br>
Cheers,<br>
Kacper<br>
<br>
<br>_______________________________________________<br>
yt-dev mailing list<br>
<a href="mailto:yt-dev@lists.spacepope.org">yt-dev@lists.spacepope.org</a><br>
<a href="http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org" target="_blank">http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org</a><br>
<br></blockquote></div><br><br clear="all"><div><br></div>-- <br>Cameron Hummels<div>Postdoctoral Researcher</div><div>Steward Observatory</div><div>University of Arizona</div><div><a href="http://chummels.org" target="_blank">http://chummels.org</a></div>


</div>