Code review comment for lp:~fdo.perez/ipython/trunk-dev

Revision history for this message
Brian Granger (ellisonbg) wrote :

I just had fun doing this code review. Launchpad has really improved its code review interface. I really like how you can look through the diffs for each file now!

One general comment: I know you like to code in a single branch, but it makes it more difficult to review a branch when there are many revisions on a wide range of topics. I don't think each revision should go in its own branch, but when there is a larger set of revisions addressing a single issue, having all of those revisions in a single topic branch would be nice and make review easier. Also, smaller branches allow code that *is* finished to get into trunk faster without waiting for unrelated code to be finished and reviewed. I am guilty of the "big branch" workflow myself though.

r1168:

As you go through file and clean up the copyright info, please convert the copyright header to our standard one that references the ipython development team. Any specific mention of module authors or maintainers should go into the module docstring.

r1169:

Are the numpy helper scripts for converting docstrings in place and working with our IPython?

How do we want to handle references in our docs. Sphinx can now create a nice references section in the pdf files, but you have to use a particular format for the references. The current form of the references you have put in::

    .. _PEP 257: http://www.python.org/peps/pep-0257.html

I don't think will end up in the references section. How does numpy handle such things. Have a look at how references are handled in the kernel documentation to see how I have been handling this. My way may not be the best. Let's figure out how all of us should handle this and then document it in our docs.

r1171:

In ipy_profile_zope.py. Should we just remove all the old __author__, etc. module attributes?

All other revisions are great.

review: Needs Fixing

« Back to merge proposal