[IPython-dev] Sprints for IPython at Scipy India 2010
Wed Dec 8 09:38:59 CST 2010
Thanks for bringing all of this up...
A few things that come to mind immediately:
> - HTML5 backend support for matplotlib in the html notebook. John
> Hunter is also coming to the conference/sprints, so this would make a
> perfect topic for joint work. Though I'd love to have finished
> merging James' branch before that happens...
Yes, this might be a little premature at this point. But some prototyping
would be helpful. I am not sure the model we have is consistent with the
current HTML5 matplotlib backend.
> - Website work: I'd like to move us away from the Moin wiki as our
> main site into a standalone, sphinx-generated website. The wiki could
> continue to exist in a reduced form for purely wiki-type things
> (cookbook recipes, etc), but the bulk of the site would be much better
> as a sphinx-generated site, hopefully with a nice theme that
> differentiates it visually from the standard documentation themes.
I am +100 on this. Doing an audit of the website, updating the content and
moving things over the sphinx would be extremely helpful and very doable for
new folks. It could also be worked on by a number of people in parallel.
> This project has the advantage of requiring less/no knowledge of the
> core codebase, while being very useful to the project at large.
> - Attacking any of the critical bug fixes we have listed on the site,
> in particular working on the unicode mess.
> - Documentation audit/update. Our docs have fallen badly behind and
> need a solid audit to identify the problems, as well as good tutorials
> to be written for some of the new features (qt console, new paralllel
> branch, etc). Again, very useful and not requiring detailed knowledge
> of the codebase.
I agree that the documentation needs lots of work. But, much of the stuff
that needs to be documented (esp the new parallel stuff) is far from being
API stable. The last thing we want is more docs that will quickly become
stale. At this point, I think we should focus on two things:
* An audit that goes through our docs and labels each section with a set of
classifiers like: delete, update, rewrite, add, ...
* Updating the docs for the sections that describe completely stable code,
APIs and interfaces. There are huge sections of the docs that have not been
touched for years and have not even been fully updated to use all that
Sphinx has to offer.
- Improving test coverage (and implementing coverage reporting in the
> first place, so we know where we stand).
I have a feeling that this is probably a tough target for new folks.
> - Auditing and triaging the bug list for obsolete/incomplete bugs that
> don't apply to trunk anymore, closing them as needed. Right now we
> have a lot of 'weed growth' in the bug list.
Yep, this would be really great.
- Commenting on the existing open pull requests so that we can move
> them forward or merge if ready.
> - Plus, all of the things I mentioned to Daniel as possible gsoc ideas
> (the sprint time would just be a starter for that, obviously).
> Thoughts, ideas on things that are achievable in a 2-day sprint? Or
> at least for which such a sprint would make a useful start?
There is also some nice qt work to be done:
* Create a more full blown QtApp for the qtconsole with useful menus, etc.
* Add new sub widgets that for example show the state of the kernel and have
buttons for restarting, etc.
> I intend to give an overview talk of the project and a hands-on
> tutorial of the workflow at the start, so that everyone there at least
> gets a feel for how the gears move. But suggestions on specific
> topics that can be finished in two days starting from zero would be
> IPython-dev mailing list
Brian E. Granger, Ph.D.
Assistant Professor of Physics
Cal Poly State University, San Luis Obispo
-------------- next part --------------
An HTML attachment was scrubbed...
More information about the IPython-dev